question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

""" Leading summary whitespace (as in this issue title)."""

See original GitHub issue

For better readability, some people prefer inserting a space between the triple quotes """ and the summary text:

def is_ascii(text):
    """ Checks if contains only ASCII characters."""
    return all(ord(letter) < 128 for letter in text)

The leading whitespace:

       🡇
    """ Checks if contains only ASCII characters."""

Without that whitespace:

    """Checks if contains only ASCII characters."""

We may add an option --leading-summary-space or --pre-summary-space or --space-before-summary or --space-after-triple-quotes… What option name do you prefer?

Attention, this option has no effect on multi-lines docstring when --pre-summary-newline is used.

Thanks

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:8 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
ndevenishcommented, Nov 28, 2019

--pre-summary-space matches the --pre-summary-newline option for naming, so would probably be the least confusing.

0reactions
weibullguycommented, Aug 6, 2022

Closed by #46

Read more comments on GitHub >

github_iconTop Results From Across the Web

how to add leading blank spaces to Title statement
I want to add few Leading blank spaces to the Title in my excel report generated by PROC REPORT using tagsets.ExcelXP. TITLE J=LEFT...
Read more >
what is trailing whitespace and how can I handle this?
Trailing whitespace is any spaces or tabs after the last non-whitespace character on the line until the newline. In your posted question, there...
Read more >
Page Title outputting leading/trailing whitespace within H1
My Drupal 7 site is printing out leading and trailing whitespace and a line break within the page title <h1> . The following...
Read more >
Crafting an Appropriate Running Title for Your Scientific Paper
Requirements for running titles vary between journals, but generally, they must be 50-60 characters long at most, often including spaces.
Read more >
How whitespace is handled by HTML, CSS, and in the DOM
Whitespace is any string of text composed only of spaces, tabs or line breaks (to be precise, CRLF sequences, carriage returns or line...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found