Revise doc comments for API reference style. #350
Merged
Conversation
This file contains hidden or 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
- Fix spelling error in parameter name (invertion --> inversion). - Add docs for parameters and return values. - Use indicative instead of imperative for method/function/initializer abstracts. (Match a regex. --> Matches a regex.) - Don't use code voice in abstracts, or symbol names as English nouns. - Use contractions per Apple style. - Turn /// comments that contain notes for this API's implementers into plain // comments, to omit that content from the docs. Move them before the /// comments, to keep doc comments immediately adjacent to the declaration they documents.
amartini51
force-pushed
the
amartini/docs_91301229
branch
from
2ee6aec to
ab308ee
Compare
amartini51
commented
Apr 25, 2022
|
@hamishknight for regex parser comments |
hamishknight
approved these changes
Apr 26, 2022
Co-authored-by: Nate Cook <[email protected]>
|
@swift-ci test |
|
Looking at the CI builder failures, I don't think they came from this PR's changes, since everything except the spelling change to a parameter name is in comments. @natecook1000 Do you mind taking a look with me? |
bjlanier
approved these changes
Apr 27, 2022
milseman
reviewed
Apr 27, 2022
|
@swift-ci please test |
Confirmed (using the command below) that this branch now contains only
changes to doc comments, changes to // comments where content was moved
into or out of a doc comment, and one spelling correction to code.
% git diff origin/main... |
grep -v '^+ *///\|- *///' |
grep -v '^@@' |
grep -v '^ ' |
grep -v '^+++\|^---' |
grep -v '^diff --git' |
grep -v '^index '
+ // Individual public API functions are in the generated Variadics.swift file.
+// For now, we use String as the source while prototyping...
+
+ // NOTE: Currently, this means we have raw quotes.
+ // Better would be to have real Swift string delimiter parsing logic.
+
+ // NOTE: traditional comments are not nested. Currently, we are neither.
+ // Traditional comments can't have `)`, not even escaped in them either, we
+ // can. Traditional comments can have `*/` in them, we can't without
+ // escaping. We don't currently do escaping.
+
- // Finish, flush, and clear. Returns the rendered output
+ // Finish, flush, and clear.
+ //
+ // - Returns: The rendered output.
+ // Note: The `Script` enum includes the "meta" script type "Katakana_Or_Hiragana", which
+ // isn't defined by https://www.unicode.org/Public/UCD/latest/ucd/Scripts.txt,
+ // but is defined by https://www.unicode.org/Public/UCD/latest/ucd/PropertyValueAliases.txt.
+ // We may want to split it out, as it's the only case that is a union of
+ // other script types.
+
+// TODO: These should become aliases for the Block (blk) Unicode character
+// property.
+
- // Ensures `.0` always refers to the whole match.
- // Allows `.0` when `Match` is not a tuple.
- func withInversion(_ invertion: Bool) -> Self {
+ func withInversion(_ inversion: Bool) -> Self {
- if invertion {
+ if inversion {
|
@swift-ci Please test. |
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.
abstracts. (Match a regex. → Matches a regex.)
///comments that contain notes for this API's implementers into plain//comments, to omit that content from the docs. Move them before the///comments, to keep doc comments immediately adjacent to the declaration they documents.