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

Docstrings for xrefs require an update #902

Open
dandhlee opened this issue Apr 5, 2024 · 0 comments
Open

Docstrings for xrefs require an update #902

dandhlee opened this issue Apr 5, 2024 · 0 comments
Labels
api: firestore Issues related to the googleapis/python-firestore API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@dandhlee
Copy link
Contributor

dandhlee commented Apr 5, 2024

Internal issue: b/237292233

Looks like xrefs are still in their old format like https://github.com/googleapis/python-firestore/blob/2a168765d51e89971a2105085377088b4c815bca/google/cloud/firestore_v1/async_batch.py#L53C26-L53C75.

The correct xref should be google.cloud.firestore_v1.write.WriteResult.

This seems like an issue throughout the library, impacting customers to not be able to find the correct definition links and the generator not being able to generate proper cross referenced links.

@product-auto-label product-auto-label bot added the api: firestore Issues related to the googleapis/python-firestore API. label Apr 5, 2024
@dandhlee dandhlee added priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API. labels Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: firestore Issues related to the googleapis/python-firestore API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

1 participant