Improve parsing & formatting of help page descriptions#680
Merged
lgarber-akamai merged 3 commits intolinode:devfrom Nov 19, 2024
Merged
Improve parsing & formatting of help page descriptions#680lgarber-akamai merged 3 commits intolinode:devfrom
lgarber-akamai merged 3 commits intolinode:devfrom
Conversation
lgarber-akamai
commented
Nov 13, 2024
| # Ensure the summary has punctuation | ||
| self.summary = operation.summary.rstrip(".") + "." | ||
|
|
||
| self.description_rich, self.description = simplify_description( |
Contributor
Author
There was a problem hiding this comment.
We don't consume OpenAPIOperation(...).description currently but I figured it'd be good to future-proof 🙂
lgarber-akamai
commented
Nov 13, 2024
| @@ -5,15 +5,15 @@ | |||
| import functools | |||
Contributor
Author
There was a problem hiding this comment.
The changes in this file originated in #639, which provides a bit more context for why they were made.
ezilber-akamai
approved these changes
Nov 14, 2024
Contributor
ezilber-akamai
left a comment
There was a problem hiding this comment.
Thanks for fixing this! Unit tests are passing locally and manual test looked good too.
zliang-akamai
approved these changes
Nov 19, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 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.pyfile with the following contents:python3 dump_descriptions.py.