Skip to content

Commit e3a49b3

Browse files
authored
Merge pull request #2130 from JinShil/style_guide
Wordsmithing style guide's doc comments merged-on-behalf-of: Sebastian Wilzbach <sebi.wilzbach@gmail.com>
2 parents 50daf31 + 75c1b8f commit e3a49b3

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

dstyle.dd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ class MyClass
396396
)
397397

398398
$(LISTSECTION phobos_documentation, Documentation,
399-
$(LI Every public symbol be exposed on the documentation:)
399+
$(LI Every public symbol should be exposed in the documentation:)
400400
---
401401
/// A public symbol
402402
enum myFancyConstant;
@@ -420,7 +420,7 @@ bool isPositive(int number)
420420
return number > 0;
421421
}
422422
---
423-
$(LI Text in sections (e.g. `Params:`, `Returns:`, `See_Also`) should be indented by one level if spans more than the line of the section.)
423+
$(LI Text in sections (e.g. `Params:`, `Returns:`, `See_Also`) should be indented by one level if it spans more than the line of the section.)
424424
$(LI Documentation comments should not use more than two stars `/**` in the header line.)
425425
$(LI Block comments (`/**`) should be used - not nesting block comments (`/++`))
426426
$(LI Global functions shouldn't indent their documentation block nor use stars as indentation.)

0 commit comments

Comments
 (0)