File tree Expand file tree Collapse file tree 1 file changed +4
-3
lines changed Expand file tree Collapse file tree 1 file changed +4
-3
lines changed Original file line number Diff line number Diff line change @@ -2197,9 +2197,10 @@ comment isn't needed?" Improve the code and then document it to make
2197
2197
it even clearer.
2198
2198
____
2199
2199
2200
- === Self-Documenting Code [[self-documenting-code]]
2200
+ === Self-Explanatory Code
2201
2201
2202
- Endeavor to make your code as self-documenting as possible.
2202
+ Endeavor to make your code as self-explanatory as possible.
2203
+ If you fail to achieve this follow the rest of the guidelines in this section.
2203
2204
2204
2205
=== Heading Comments [[four-semicolons-for-heading-comments]]
2205
2206
@@ -2661,7 +2662,7 @@ Neither start nor end your docstrings with any whitespace.
2661
2662
42)
2662
2663
----
2663
2664
2664
- === Docstring After Fn Name [[docstring-after-fn-name]]
2665
+ === Place Docstring After Function Name [[docstring-after-fn-name]]
2665
2666
2666
2667
When adding a docstring -- especially to a function using the above form -- take
2667
2668
care to correctly place the docstring after the function name, not after the
You can’t perform that action at this time.
0 commit comments