Skip to content

Commit 6ae13d4

Browse files
committed
Improve a couple of headings
1 parent 152ff98 commit 6ae13d4

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2197,9 +2197,10 @@ comment isn't needed?" Improve the code and then document it to make
21972197
it even clearer.
21982198
____
21992199

2200-
=== Self-Documenting Code [[self-documenting-code]]
2200+
=== Self-Explanatory Code
22012201

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.
22032204

22042205
=== Heading Comments [[four-semicolons-for-heading-comments]]
22052206

@@ -2661,7 +2662,7 @@ Neither start nor end your docstrings with any whitespace.
26612662
42)
26622663
----
26632664

2664-
=== Docstring After Fn Name [[docstring-after-fn-name]]
2665+
=== Place Docstring After Function Name [[docstring-after-fn-name]]
26652666

26662667
When adding a docstring -- especially to a function using the above form -- take
26672668
care to correctly place the docstring after the function name, not after the

0 commit comments

Comments
 (0)