fix typos in the new xcodebuild formatter page #1133
Conversation
There was a problem hiding this comment.
@rogerluan Random thoughts:
(I also spotted a few another typos, will PR into this branch in a bit…)
| - Supports formatting Swift Package Manager output | ||
| - It's faster than `xcpretty` |
There was a problem hiding this comment.
| - It's faster than `xcpretty` | |
| - Is faster than `xcpretty` |
There was a problem hiding this comment.
I debated this when I wrote it haha I opted to use It's because when read in isolation it sounds a lot better than is (although I acknowledge that `is``would be "more correct" here 😄 )
There was a problem hiding this comment.
As a non-English speaker I don't usually have too much of an insight into such fine details in wording, so I'd like to leave that to someone better equipped for such assessment ;D
It's just an observation, if the heading starts with "because it: …" I'm sort of expecting the lines to be an ending to this sentence. That's why my gut feeling kinda expects every line to actually a) start with lowercase, b) finish the sentence. Like:
| - It's faster than `xcpretty` | |
| - is faster than… | |
| - supports Xcode… | |
| - supports formatting… |
(but that stylisation is not present in other places of the text with all bullet lines being capitalised even when they form a part of a sentence… hence my hesitation to suggest a "correction" as I'm not too skilled in language matters TBH;D…)
There was a problem hiding this comment.
That makes sense but makes skimming through the page a bit more confusing and requires more reading (cognitive friction) IMO. I've updated it to something else that might help, lmk what you think @janbrasna 😊
There was a problem hiding this comment.
I've checked the copy style in other parts of the docs and yes, they are all sentence-case (w/o a closing full stop) when used as bullet/list items usually used in an infinitive form following the preceding intro text. So please disregard any comments I may have made.
The only form I could've come up with is to reword in a way to make use of the infinitives like:
… is currently recommended as it was designed to:
- Support Xcode…
- Support formatting…
- Be faster than…
(or any cumbersome formulations as "it is known to:", "it is intended to:" but that's all weird compared to just saying it's what it is…) — besides that I'm out of any drive-by improvements, sorry;)
Co-authored-by: Jan Brašna <[email protected]>
|
Thanks for the improvements @janbrasna ! 🤗 |
|
@rogerluan, could you please rebase this to test the Netlify preview build? |
|
Done @revolter 🙏 |
Just fixed some typos and improved wording a bit :)