Skip to content
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

DOC: minor docstring errors from renamed cli args #201

Merged
merged 1 commit into from
Sep 12, 2024

Conversation

ZLLentz
Copy link
Member

@ZLLentz ZLLentz commented Sep 12, 2024

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

@ZLLentz ZLLentz requested a review from tangkong September 12, 2024 15:55
Copy link
Contributor

@tangkong tangkong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you re-run the readme-conversion script here? Do we need to? Nope these are function docstrings not argparse help text 👍

@ZLLentz ZLLentz merged commit 953c167 into pcdshub:master Sep 12, 2024
2 checks passed
@ZLLentz ZLLentz deleted the doc_fix_docstrings branch September 12, 2024 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants