Skip to content

Commit

Permalink
Updated wording
Browse files Browse the repository at this point in the history
  • Loading branch information
guptapriya authored and martinwicke committed Aug 3, 2020
1 parent b275e4c commit d71d1cc
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion governance/api-reviews.md
Expand Up @@ -161,7 +161,12 @@ which may be needed when the default behavior is changing.

#### Documented types

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.
Arguments and return values to public APIs must be either public types, or
inherit from a public type. This ensures that the argument types and return
value types are documented and gives users clear 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.

### Does it belong in TF at all?

Expand Down

0 comments on commit d71d1cc

Please sign in to comment.