docs: fix broken Workbench :meth: cross-references in workbench docstrings#7977
Open
JOJOCrazy123 wants to merge 1 commit into
Open
docs: fix broken Workbench :meth: cross-references in workbench docstrings#7977JOJOCrazy123 wants to merge 1 commit into
JOJOCrazy123 wants to merge 1 commit into
Conversation
Author
|
Hi maintainers, this PR is ready for review, but the workflow is still awaiting maintainer approval. Could someone please approve the workflow and review the PR when convenient? Thank you! |
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
1 participant
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.
Why
The
Workbenchasync context manager docstrings reference a class namedWorkBench(capitalB), which does not exist. The actual class isWorkbench, and the class-level docstring in the same file already uses the correct references. As a result, the Sphinx:meth:cross-references in__aenter__and__aexit__fail to resolve.What
Fix the two broken cross-references in
python/packages/autogen-core/src/autogen_core/tools/_workbench.py:Docstring-only change; no behavior or API changes. Now consistent with the existing correct references in the
Workbenchclass docstring.