nep1: guidelines for getters and setters (#17645)

* nep1: guidelines for getters and setters * address a comment
2021-04-09 00:09:04 -05:00 · 2021-04-09 00:09:04 -05:00 · 826ad2f36f
commit 826ad2f36f
parent 13b958eb45
1 changed files with 9 additions and 0 deletions
--- a/doc/nep1.rst
+++ b/doc/nep1.rst
@ -301,3 +301,12 @@ Miscellaneous
    let a = """foo
    bar
    """
+
+- A getter API for a private field `foo` should preferably be named `foo`, not `getFoo`.
+  A getter-like API should preferably be named `getFoo`, not `foo` if:
+    * the API has side effects
+    * or the cost is not `O(1)`
+  For in between cases, there is no clear guideline.
+
+- Likewise with a setter API, replacing `foo` with `foo=` and `getFoo` with `setFoo`
+  in the above text.