Use the third person in method docs #6778
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
In my projects I always use no-person references in the method introduction and then the third person in description. E.g: # Set foo to bar. May raise. Uploads to server.
def foo
endSo in the docs summary it says Which approach is right? |
|
According to Documenting code you should always document methods in the third person:
|
z64
reviewed
Sep 24, 2018
src/array.cr
Outdated
| @@ -190,7 +190,7 @@ class Array(T) | |||
| size <=> other.size | |||
| end | |||
|
|
|||
| # Set intersection: returns a new `Array` containing elements common to `self` | |||
| # Sets intersection: returns a new `Array` containing elements common to `self` | |||
There was a problem hiding this comment.
This is actually a noun, not a verb. ("Set intersection", as in the intersection of two sets)
Same below on the next diff line for this file
bcardiff
approved these changes
Sep 24, 2018
RX14
requested changes
Sep 25, 2018
src/compiler/crystal/compiler.cr
Outdated
| @@ -83,7 +83,7 @@ module Crystal | |||
| # one LLVM module is created for each type in a program. | |||
| property? single_module = false | |||
|
|
|||
| # Set to a `ProgressTracker` object which tracks compilation progress. | |||
| # Sets to a `ProgressTracker` object which tracks compilation progress. | |||
There was a problem hiding this comment.
This was correct before, although badly worded (my docs, sorry)
src/compiler/crystal/program.cr
Outdated
| @@ -110,7 +110,7 @@ module Crystal | |||
| # The main filename of this program | |||
| property filename : String? | |||
|
|
|||
| # Set to a `ProgressTracker` object which tracks compilation progress. | |||
| # Sets to a `ProgressTracker` object which tracks compilation progress. | |||
RX14
added
the
kind:bug
added 2 commits
September 25, 2018 14:44
…erson3 this is necessary
RX14
approved these changes
Sep 25, 2018
ezrast
pushed a commit
to ezrast/crystal
that referenced
this pull request
Oct 2, 2018
* Use the third person * Remove the s from 2 nouns * Remove 2 s'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are some methods left that don't use the third person.