Skip to content

Commit fdff66a

Browse files
authored
Update README.md
1 parent eb5287f commit fdff66a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ When `@section` is used, shdoc can not by itself detect the end of a section. It
268268
This annotation can be used to disable the grouping again for the following functions. It has no effect on its own. Captions for functions contained in sections are level 3 (`###`),
269269
ungrouped functions are level 2 (`##`).
270270
271-
**original**
271+
**original:**
272272
In the original, there is no terminated for `@section` and no adjustment of header levels depending on section nesting. There, all functions are always level 3, sections are level 2 and section descriptions
273273
are inserted in-between. So there is no visible distinction between function descriptions contained in a section and others not contained. In fact, once a `@section` was specified, everything following it
274274
appears as if it is contained in that.

0 commit comments

Comments
 (0)