Skip to content
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.

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

New Rule: require summary description. #108

Open
dtracers opened this issue May 31, 2015 · 0 comments
Open

New Rule: require summary description. #108

dtracers opened this issue May 31, 2015 · 0 comments

Comments

@dtracers
Copy link
Contributor

this is an extension of #106 and #99

Which is that a summary description is required with a new line and a complete sentence.

This actually a stricter version of requiring a new line. But the complete description still can follow under the new line rule. Basically there must be a period at the end of the first line. Which is then followed by a new line.

NOTE
This does not require the summary to start with an upper case letter.

examples:

/**
 * Valid summary.
 *
 * Deeper description information
 */
function foo() {
}

/**
 * Invalid summary.  Summary can only be a single sentence
 */
function bar() {
}

/**
 * Invalid summary
 * on two lines.
 */
function foobar() {
}

/**
 * lowercase summary is valid with this rule.
 */
function barfoo() {
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants