Skip to content

Commit 4edf194

Browse files
committed
update documentation comments
1 parent cbda1b9 commit 4edf194

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/maintenance/documentation-comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ It is an empty comment line. It is used to create content that helps with docume
4242

4343
Doc comments are written only as single-line comments. Range comments are not considered as documentation comments in any way.
4444

45-
When writing documentation comments within the main scope, at most one ASCII whitespace can be used. If there is any whitespace, it is ignored. All space characters (such as ASCII whitespace or tabs) are considered as indentation.
45+
When writing documentation comments within the main scope, at most one ASCII whitespace can be used. If there is any whitespace, it is ignored. All space characters (except whitespaces) (such as tabs) are considered as indentation.
4646

4747
The suggested documentation approach is to write the main scopes starting with a single whitespace, and indent each sub-scope with a tab.
4848

0 commit comments

Comments
 (0)