Skip to content

Docs build fails in python-monitoring due to incorrectly formatting list #1627

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

Closed
parthea opened this issue Mar 20, 2023 · 0 comments · Fixed by #1628
Closed

Docs build fails in python-monitoring due to incorrectly formatting list #1627

parthea opened this issue Mar 20, 2023 · 0 comments · Fixed by #1628
Assignees

Comments

@parthea
Copy link
Contributor

parthea commented Mar 20, 2023

See PR googleapis/python-monitoring#535 which has a docs presubmit failing with

sphinx.errors.SphinxWarning: /home/runner/work/python-monitoring/python-monitoring/google/cloud/monitoring_v3/services/snooze_service/async_client.py:docstring of google.cloud.monitoring_v3.services.snooze_service.async_client.SnoozeServiceAsyncClient.update_snooze:42:Inline interpreted text or phrase reference start-string without end-string.

The issue is that the list is not being parsed correctly. Formatting issues appear in the docstring here.

For example, there is a large gap between two words considered read-only when it should be considered read-only

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant