Fix argument typo in async inference documentation #2361
Merged
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR corrects the documentation to use the proper underscore naming convention for a command-line flag. The flag name is updated from --debug-visualize-queue-size (with hyphens) to --debug_visualize_queue_size (with underscores) to match the actual implementation.
Key Changes:
- Updated command-line flag reference from hyphenated to underscore notation in two locations within the async documentation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
Good catch 👍 |
imstevenpmwork
added
bug
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
What this does
The documentation for asynchronous inference sometimes denotes the debug visual queue size argument as
--debug-visualize-queue-sizeinstead of--debug_visualize_queue_size. This is a small fix to ensure it is always the correct version (--debug_visualize_queue_size).How it was tested
Tested by building the documentation and checking the problematic argument locally.