This repository was archived by the owner on Feb 20, 2026. It is now read-only.
docs: Add parameters to second commit overload#1343
Merged
danieljbruce merged 4 commits intomainfrom Oct 29, 2024
Merged
Conversation
|
🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use -- conventional-commit-lint bot |
…//github.com/googleapis/nodejs-datastore into 372734275-add-descriptions-to-some-overloads
daniel-sanche
approved these changes
Oct 25, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary:
In the Google cloud documentation, for many parameters there is no description in the Description column. In particular, there is never parameter description documentation for overloads of methods. This PR provides documentation for parameters in one overload of the commit function to serve as an example of what changes need to be made for function overloads in the documentation everywhere.
For each overload we should provide documentation for the parameters and return descriptions because the tables are already there, but we shouldn't provide any more information because that will make the GCP documentation webpages too long and just repeat information that is already there.
For instance, below is a screenshot of what the documentation looks like for one of the commit overloads:
The change is that the tables should be filled in with types and descriptions under the description column.
Next steps:
Go through the nodejs-datastore source code and add parameter and return value documentation to all of the method overloads.