DOC: minor docstring errors from renamed cli args #201
Conversation
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
tangkong
approved these changes
Sep 12, 2024
Contributor
tangkong
left a comment
tangkong
left a comment
There was a problem hiding this comment.
Did you re-run the readme-conversion script here? Do we need to? Nope these are function docstrings not argparse help text 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
In one of the ioc-deploy PRs we adjusted the cli arg specifics which made these docstrings incorrect.
This PR fixes a few minor docstrings that I noticed this morning.
Motivation and Context
Incorrect docs can be confusing
How Has This Been Tested?
No functional changes to the code
Where Has This Been Documented?
Here only