Skip to content

Wordsmithing style guide's doc comments #2130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dlang-bot merged 1 commit into from
Jan 27, 2018
Merged

Wordsmithing style guide's doc comments #2130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions dstyle.dd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ class MyClass
)

$(LISTSECTION phobos_documentation, Documentation,
$(LI Every public symbol be exposed on the documentation:)
$(LI Every public symbol should be exposed in the documentation:)
---
/// A public symbol
enum myFancyConstant;
Expand All @@ -420,7 +420,7 @@ bool isPositive(int number)
return number > 0;
}
---
$(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.)
$(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.)
$(LI Documentation comments should not use more than two stars `/**` in the header line.)
$(LI Block comments (`/**`) should be used - not nesting block comments (`/++`))
$(LI Global functions shouldn't indent their documentation block nor use stars as indentation.)
Expand Down