search

Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.
MIT License
4.36k stars 2.71k forks source link

azure-servicefabric needs docstring updates for sphinx #33535

Open azure-sdk opened 6 months ago

azure-sdk commented 6 months ago

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-servicefabric Sphinx build: Link to build (2024-06-29) How to fix: Run the strict-sphinx tox command at the library package-level and resolve the docstring errors and warnings. 1) ../azure-servicefabric>pip install "tox<5" 2) ../azure-servicefabric>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.

github-actions[bot] commented 6 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @juhacket @QingChenmsft @vaishnavk.