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

azure-schemaregistry needs docstring updates for sphinx #33548

Closed
azure-sdk opened this issue Dec 16, 2023 · 0 comments · Fixed by #35018
Closed

azure-schemaregistry needs docstring updates for sphinx #33548

azure-sdk opened this issue Dec 16, 2023 · 0 comments · Fixed by #35018
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Schema Registry sphinx

Comments

@azure-sdk
Copy link
Collaborator

azure-sdk commented Dec 16, 2023

ACTION NEEDED: All sphinx errors and warnings must be fixed by 2024-04-15. The build will begin to fail for this library if errors are not fixed.

This issue indicates that your library reference documentation is rendering with errors. To avoid customer issues, please ensure you take care of these errors and warnings ASAP.

Library name: azure-schemaregistry
Sphinx build: Link to build (2024-03-31)
How to fix: Run the strict-sphinx tox command at the library package-level and resolve the docstring errors and warnings.

  1. ../azure-schemaregistry>pip install "tox<5"

  2. ../azure-schemaregistry>tox run -e strict-sphinx -c ../../../eng/tox/tox.ini --root .

  3. Once resolved, set strict_sphinx = true in the package's pyproject.toml file.

See Sphinx and docstring checker for more information.

@kristapratico kristapratico added Client This issue points to a problem in the data-plane of the library. Schema Registry labels Jan 2, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jun 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Schema Registry sphinx
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants