Skip to content

Strip only the first occurence of summary from details#536

Open
FrostyX wants to merge 2 commits into
python-restx:masterfrom
FrostyX:docstring-details
Open

Strip only the first occurence of summary from details#536
FrostyX wants to merge 2 commits into
python-restx:masterfrom
FrostyX:docstring-details

Conversation

@FrostyX

@FrostyX FrostyX commented Apr 15, 2023

Copy link
Copy Markdown

If we have the following method docstring

"""
Create a package
Create a package inside your project. And now diving deep into the details...
"""

Then IMHO the expected behavior is "Create a package" displayed as a summary and
the rest displayed as details. That's not what happens using raw.replace,
the result is now only "inside your project. And now diving deep into the
details..."

If we have the following method docstring

    """
    Create a package
    Create a package inside your project. And now diving deep into the details...
    """

Then IMHO the expected behavior is "Create a package" displayed as a summary and
the rest displayed as _details_. That's not what happens using `raw.replace`,
the result is now only "inside your project. And now diving deep into the
details..."
@FrostyX

FrostyX commented Aug 14, 2023

Copy link
Copy Markdown
Author

bump

1 similar comment
@FrostyX

FrostyX commented Oct 5, 2023

Copy link
Copy Markdown
Author

bump

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.

1 participant