new: Display example usage in command help pages #567
Merged
Conversation
This file contains 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
lgarber-akamai
requested review from
jriddle-linode and
yec-akamai
and removed request for
a team
lgarber-akamai
commented
Jan 8, 2024
| @@ -8,4 +8,3 @@ requests-mock==1.11.0 | |||
| boto3-stubs[s3] | |||
| build>=0.10.0 | |||
| twine>=4.0.2 | |||
| packaging>=23.2 | |||
There was a problem hiding this comment.
This was already defined in requirements.txt 👍
yec-akamai
approved these changes
Jan 8, 2024
jriddle-linode
approved these changes
Jan 9, 2024
Closed
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 adds a new
Example Usagesection to generated command help pages. These examples are pulled from thex-code-samplesOpenAPI spec extension.This functionality was previously implemented before the spec parser rework (#299, #303) but was never merged. Thanks @bavedarnow and @Dorthu for the original idea and implementations!
Closes #299, #303
📷 Preview
✔️ How to Test
The following testing instructions assume you have pulled down this change and run
make install.Running unit tests:
Manual testing:
linodes create(POST) command:Example Usagesection displays as expected.linodes view(GET) command:Example Usagesection displays as expected.linodes update(PUT) section.Example Usagesection displays as expected.linodes delete(DELETE) section.Example Usagesection displays as expected.