Skip to content

azure-communication-chat needs docstring updates for sphinx #33566

Closed

Description

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-communication-chat
Sphinx build: Link to build (2024-03-04)
How to fix: Run the strict-sphinx tox command at the library package-level and resolve the docstring errors and warnings.

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

  2. ../azure-communication-chat>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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    ClientThis issue points to a problem in the data-plane of the library.Communication - ChatService AttentionWorkflow: This issue is responsible by Azure service team.sphinx

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions