Proofread pass of the articles #393
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
added 10 commits
May 1, 2024 13:02
In the last example, I changed 8 to 5 to conform with Swift’s current release number.
chuckdude
requested review from
stmontgomery,
grynspan,
dennisweissmann,
briancroom,
SeanROlszewski and
suzannaratcliff
as code owners
grynspan
reviewed
May 1, 2024
grynspan
reviewed
May 1, 2024
| @@ -61,7 +61,7 @@ The following language comment styles are supported: | |||
| Test comments which are automatically added from source code comments preserve | |||
| their original formatting, including any prefixes like `//` or `/**`. This | |||
| is because the whitespace and formatting of comments can be meaningful in some | |||
| circumstances or aid in understanding the comment—for example, when a comment | |||
| circumstances or aid in understanding the comment; for example, when a comment | |||
There was a problem hiding this comment.
A semi-colon is not correct here.
grynspan
reviewed
May 1, 2024
grynspan
reviewed
May 1, 2024
| - The strings `"red"`, `"orange"`, `"yellow"`, `"green"`, `"blue"`, or | ||
| `"purple"`, representing corresponding predefined instances of ``Tag``, i.e. | ||
| - The strings `red`, `orange`, `yellow`, `green`, `blue`, or | ||
| `purple`, represent corresponding predefined instances of ``Tag``, like |
There was a problem hiding this comment.
We're not saying "The strings [...] represent", we're saying "The strings—and by the way, they represent". Compare the other cases in this list.
grynspan
reviewed
May 1, 2024
|
|
||
| For example, to set the color of the tag `"critical"` to orange and the color of | ||
| the tag `.legallyRequired` to teal, the contents of `"tag-colors.json"` can | ||
| For example, to set the color of the `critical` tag to orange and the color of |
There was a problem hiding this comment.
critical here is a string literal and needs the quotes.
grynspan
reviewed
May 1, 2024
| the color in a device-independent RGB color space; or | ||
| - The `null` literal value, representing "no color." | ||
| ``Tag/purple``. | ||
| - A string of the form `#RRGGBB`, containing a hexadecimal representation of |
There was a problem hiding this comment.
This is a string literal and needs the quotes.
grynspan
reviewed
May 1, 2024
grynspan
reviewed
May 1, 2024
grynspan
reviewed
May 1, 2024
grynspan
reviewed
May 1, 2024
grynspan
reviewed
May 1, 2024
grynspan
reviewed
May 1, 2024
grynspan
reviewed
May 6, 2024
grynspan
reviewed
May 6, 2024
grynspan
reviewed
May 6, 2024
Changed asterisks back to underscores for italic.
Changed asterisks back to underscores for italics. Co-authored-by: Jonathan Grynspan <jgrynspan@apple.com>
Put back the quotation marks.
Put back the quotation marks.
Put back the quotation marks.
Put back the quotation marks.
Put back the quotation marks, and reverted back to representing.
Put back the quotation marks.
Put back the quotation marks.
Put back the quotation marks.
Reverted back to 8s
chuckdude
commented
May 6, 2024
This is correct; thanks for catching this. Co-authored-by: Jonathan Grynspan <jgrynspan@apple.com>
Committing this fix.
Reverted back to the original.
Added a missing comma.
Fixed, per Jonathan's recommendation.
chuckdude
commented
May 6, 2024
chuckdude
commented
May 12, 2024
I think we can eliminate the “Kinds of relationship” heading here, and just make this a continuous part of the higher level section.
grynspan
approved these changes
May 13, 2024
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.
Made a proofreading pass through the articles.
Motivation:
To verify there are no typos.
Modifications:
Largely, made edits to correct tense and turn text like "it is" or "does not" into contractions ("it's" and "doesn't", respectively).
Result:
Clean up pass for initial release.
Checklist: