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

docs build failed in google-analytics-admin #1916

Open
parthea opened this issue Jan 25, 2024 · 0 comments
Open

docs build failed in google-analytics-admin #1916

parthea opened this issue Jan 25, 2024 · 0 comments
Labels
type: cleanup An internal cleanup or hygiene concern.

Comments

@parthea
Copy link
Contributor

parthea commented Jan 25, 2024

See https://github.com/googleapis/googleapis-gen/blob/e7b50944e6637b70bcedd0bab5d666b2f22ef757/google/analytics/admin/v1alpha/google-analytics-admin-v1alpha-py/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py#L10143 where there is an underscore which is not escaped. If a trailing underscore is not escaped then it is interpreted as a hyperlink.

This caused the docs build to fail with

sphinx.errors.SphinxWarning: /home/runner/work/google-cloud-python/google-cloud-python/packages/google-analytics-admin/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py:docstring of google.analytics.admin_v1alpha.services.analytics_admin_service.async_client.AnalyticsAdminServiceAsyncClient.create_calculated_metric:24:Unknown target name: "a-za-z0-9".

Instead of

            calculated_metric_id (str):
                Required. The ID to use for the calculated metric which
                will become the final component of the calculated
                metric's resource name.

                This value should be 1-80 characters and valid
                characters are /[a-zA-Z0-9_]/, no spaces allowed.

It should be

            calculated_metric_id (str):
                Required. The ID to use for the calculated metric which
                will become the final component of the calculated
                metric's resource name.

                This value should be 1-80 characters and valid
                characters are `[a-zA-Z0-9_]`, no spaces allowed.

See https://github.com/googleapis/google-cloud-python/actions/runs/7648352502/job/20840980593?pr=12222

We should add a linter rule to check for trailing underscores in proto comments which are not escaped via https://github.com/googleapis/api-linter .

@parthea parthea added the type: cleanup An internal cleanup or hygiene concern. label Jan 25, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jan 25, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 1, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jul 8, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant