chore: add docstrings on datastore type utils #13728
Merged
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.
Description of changes
Add docstrings on the exposed type util functions so that they're represented and/or hidden in customer-facing docs correctly.
For most of these utils, that means explicitly marking them as
@private
to hide them from docs generation. It seemed easy enough to add a little context on the meaning of the return types for most of these as well, so that's included, but should be hidden from customer docs -- internal context only.syncExpression
is intended for customer consumption, so a description intended for customer consumption with sample code (borrowed from docs site) has been added.Issue #, if available
Description of how you validated changes
Docstring changes only.
Checklist
yarn test
passesChecklist for repo maintainers
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.