Home/ Questions/Q 8736189
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-06-13T10:14:59+00:00

When writing inline documentation, is there a standard method for line breaks when it

  • 0

When writing inline documentation, is there a standard method for line breaks when it comes longer lines of text (Obviously this shouldn’t happen too frequently)?

For example:

"This modules does blah blah blah blah blah blah blah blah blah blah blah blahblah blah blah blah blah blahblah blah blah blah blah blahblah blah blah blah blah blah"

Or should it be:

"This modules does blah blah blah blah blah blah blah blah blah blah blah 
blahblah blah blah blah blah blahblah blah blah blah blah blahblah blah 
blah blah blah blah"

If there is no well defined standard or tradition for this I’m not really looking for a debate, in which case the question should probably just be closed. But if there is a standard or very common practice I would like to know what it is.

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    For mulitiline comments like the example in your question, you can also use “””triple quotes””” for your comments to span over newlines.

    PEP 8 style guide recommends to

    Limit all lines to a maximum of 79 characters

    And also:

    For flowing long blocks of text (docstrings or comments), limiting the
    length to 72 characters is recommended.

    There is a particular section of the style guide concerning docstrings, a particular type of inline documentation, which you can find here.

    • 0