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: misc issues and improvements #6321

Closed
bshaffer opened this issue Jun 5, 2023 · 2 comments
Closed

docs: misc issues and improvements #6321

bshaffer opened this issue Jun 5, 2023 · 2 comments

Comments

@bshaffer
Copy link
Contributor

bshaffer commented Jun 5, 2023

More improvements are required on the docs to better support the new surface

  1. The published docs have duplicate entries for magic methods. For example: https://cloud.google.com/php/docs/reference/cloud-automl/latest/V1.Client.AutoMlClient

  2. new and previous clients aren't ordered predictably (e.g. they should be new and then previous, or vise versa, consistently - see AutoML TOC)

  3. we still don't include the namespaces, and this is even more important with the new clients (tracked in feat: add support for namespaces in the HTML template doc-pipeline#478)

  4. there are no samples for the new clients - we should include these with the @example annotation when we can!

  5. the new clients, which are in beta, are not labeled as such

  6. the __call method shows up in the docs, and we don't want it to

  7. We should include information in the top of GAPIC clients regarding the migration status to help users on libraries which contain both surfaces

Here's an idea for how we could ptentially support namespaces

Screenshot 2023-06-05 at 6 19 56 PM
@bshaffer bshaffer changed the title docs: duplicate entry for async magic methods docs: duplicate entry for async magic methods, other bugs Jun 5, 2023
@bshaffer
Copy link
Contributor Author

bshaffer commented Jun 6, 2023

@bshaffer bshaffer changed the title docs: duplicate entry for async magic methods, other bugs docs: misc issues and improvements Jun 9, 2023
@bshaffer
Copy link
Contributor Author

Confirmed these have all been fixed and published.

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

No branches or pull requests

1 participant