From d71d1ccb3afeaf79bb294eb038dacda908e6d704 Mon Sep 17 00:00:00 2001 From: guptapriya <14104855+guptapriya@users.noreply.github.com> Date: Fri, 24 Jul 2020 11:44:33 -0700 Subject: [PATCH] Updated wording --- governance/api-reviews.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/governance/api-reviews.md b/governance/api-reviews.md index b901be110..60b43cd3f 100644 --- a/governance/api-reviews.md +++ b/governance/api-reviews.md @@ -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?