Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Commit d71d1cc

Browse files
guptapriyamartinwicke
authored andcommitted
Updated wording
1 parent b275e4c commit d71d1cc

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

governance/api-reviews.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,12 @@ which may be needed when the default behavior is changing.
161161

162162
#### Documented types
163163

164-
Arguments and return values to public APIs must be either be of public types, or inherit from a public type. This ensures that the arguments and return value types are documented and gives users clearer guidance on what can be passed to a public API, and what can they do with the returned values. If it is not desirable for the user to construct these types on their own, one can choose to expose superclass with no constructor, but adequate docstrings.
164+
Arguments and return values to public APIs must be either public types, or
165+
inherit from a public type. This ensures that the argument types and return
166+
value types are documented and gives users clear guidance on what can be
167+
passed to a public API, and what can they do with the returned values.
168+
If it is not desirable for the user to construct these types on their own,
169+
one can choose to expose superclass with no constructor, but adequate docstrings.
165170

166171
### Does it belong in TF at all?
167172

0 commit comments

Comments
 (0)