From 826ad2f36f34694277f624933049de2be40e0703 Mon Sep 17 00:00:00 2001
From: Timothee Cour <timothee.cour2@gmail.com>
Date: Fri, 9 Apr 2021 00:09:04 -0500
Subject: [PATCH] nep1: guidelines for getters and setters (#17645)

* nep1: guidelines for getters and setters
* address a comment
---
 doc/nep1.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/nep1.rst b/doc/nep1.rst
index bdf8e0eab..8687725bb 100644
--- 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.