Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple lines in sections (including "returns") #42

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

vindex10
Copy link
Contributor

This pull request provides the following feature.

SomeSection:
    Description
        >>> Also with code
        >>> In multiple lines
        and output
    And now you can continue text of section

The same thing is now possible in "Returns" section, which provides an ability to give an examples of return values. It is important for consistency with Google Python Style Guide:
https://google.github.io/styleguide/pyguide.html#Comments

screenshot_2017-10-12_17-47-11

@Feneric
Copy link
Owner

Feneric commented Oct 16, 2017

Similar to the earlier one, I think this is a useful addition but we'll need to add a test case for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants