Skip to content
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
372734275-add-descriptions-to-some-overloads
Oct 29, 2024
Merged

docs: Add parameters to second commit overload#1343
danieljbruce merged 4 commits intomainfrom
372734275-add-descriptions-to-some-overloads

Conversation

@danieljbruce
Copy link
Copy Markdown
Contributor

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:

image

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.

@danieljbruce danieljbruce requested a review from a team October 25, 2024 21:10
@danieljbruce danieljbruce requested a review from a team as a code owner October 25, 2024 21:10
@product-auto-label product-auto-label bot added the size: xs Pull request size is extra small. label Oct 25, 2024
@conventional-commit-lint-gcf
Copy link
Copy Markdown

conventional-commit-lint-gcf bot commented Oct 25, 2024

🤖 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 automerge label. Good luck human!

-- conventional-commit-lint bot
https://conventionalcommits.org/

@product-auto-label product-auto-label bot added the api: datastore Issues related to the googleapis/nodejs-datastore API. label Oct 25, 2024
@danieljbruce danieljbruce added the owlbot:run Add this label to trigger the Owlbot post processor. label Oct 25, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Oct 25, 2024
@danieljbruce danieljbruce merged commit badffc2 into main Oct 29, 2024
@danieljbruce danieljbruce deleted the 372734275-add-descriptions-to-some-overloads branch October 29, 2024 14:19
@danieljbruce danieljbruce added the release-please:force-run To run release-please label Nov 4, 2024
@release-please release-please bot removed the release-please:force-run To run release-please label Nov 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api: datastore Issues related to the googleapis/nodejs-datastore API. size: xs Pull request size is extra small.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants