-
Notifications
You must be signed in to change notification settings - Fork 436
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
Comments
bshaffer
changed the title
docs: duplicate entry for async magic methods
docs: duplicate entry for async magic methods, other bugs
Jun 5, 2023
|
This was referenced Jun 7, 2023
bshaffer
changed the title
docs: duplicate entry for async magic methods, other bugs
docs: misc issues and improvements
Jun 9, 2023
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
More improvements are required on the docs to better support the new surface
The published docs have duplicate entries for magic methods. For example: https://cloud.google.com/php/docs/reference/cloud-automl/latest/V1.Client.AutoMlClient
new and previous clients aren't ordered predictably (e.g. they should be
new
and thenprevious
, or vise versa, consistently - see AutoML TOC)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)
there are no samples for the new clients - we should include these with the
@example
annotation when we can!the new clients, which are in beta, are not labeled as such
the
__call
method shows up in the docs, and we don't want it toWe 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
The text was updated successfully, but these errors were encountered: