Update README

jsh9 · Jul 20, 2023 · e02d27c · e02d27c
1 parent c93d829
commit e02d27c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -327,3 +327,8 @@ under `__init__()` rather than in the class docstring.
 If `False`, a "return" section is not necessary in the docstring if the
 function implicitly returns `None` (for example, doesn't have a return
 statement, or has `-> None` as the return annotation).
+
+### 4.10. `--check-return-types` (shortform: `-crt`, default: `True`)
+
+If True, check that the type(s) in the docstring return section and the return
+annotation in the function signature are consistent