-
Notifications
You must be signed in to change notification settings - Fork 136
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
Improve parsing & formatting of help page descriptions #680
base: dev
Are you sure you want to change the base?
Conversation
# Ensure the summary has punctuation | ||
self.summary = operation.summary.rstrip(".") + "." | ||
|
||
self.description_rich, self.description = simplify_description( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't consume OpenAPIOperation(...).description
currently but I figured it'd be good to future-proof 🙂
@@ -5,15 +5,15 @@ | |||
import functools |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changes in this file originated in #639, which provides a bit more context for why they were made.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing this! Unit tests are passing locally and manual test looked good too.
📝 Description
This pull request resolves various issues that caused help page argument descriptions to not be properly parsed, leading to malformed outputs like:
✔️ How to Test
The following test steps assume you have pulled down this PR locally and run
make install
.Unit Testing
Manual Testing
dump_descriptions.py
file with the following contents:python3 dump_descriptions.py
.