Skip to content

Strip only the first occurence of summary from details #536

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.

Sign up for GitHub

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

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

Strip only the first occurence of summary from details #536

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72f8a17
Strip only the first occurence of summary from details
FrostyX Apr 15, 2023
5101cc6
Merge branch 'master' into docstring-details
FrostyX Aug 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion flask_restx/swagger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def parse_docstring(obj):
raw = getdoc(obj)
summary = raw.strip(" \n").split("\n")[0].split(".")[0] if raw else None
raises = {}
details = raw.replace(summary, "").lstrip(". \n").strip(" \n") if raw else None
details = raw.lstrip(summary).lstrip(". \n").strip(" \n") if raw else None
for match in RE_RAISES.finditer(raw or ""):
raises[match.group("name")] = match.group("description")
if details:
Expand Down