Fix duplicate reStructuredText substitution definitions in docstrings#46
Merged
jason810496 merged 2 commits intomainfrom Jan 7, 2026
Merged
Conversation
Co-authored-by: jason810496 <[email protected]>
Copilot
AI
changed the title
[WIP] Fix duplicate substitution definition errors in documentation
Fix duplicate reStructuredText substitution definitions in docstrings
Jan 7, 2026
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
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
Sphinx documentation build was failing with 12 "Duplicate substitution definition name" errors. reStructuredText substitution definitions (e.g.,
.. _name:and.. |name|) are global scope—defining them in both sync and async method docstrings caused conflicts.Changes:
|name|_) in both sync and async docstringsAffected methods:
create_queue_async,create_partitioned_queue_async,drop_queue_asyncread_async,read_with_poll_async,set_vt_asyncdelete_async,delete_batch_async,archive_asyncmetrics_all_asyncDocumentation now builds successfully with no errors or warnings.
Status
Checklist
pre-commitwithruff)Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.