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.

Sign up for GitHub

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

fix typos in the new xcodebuild formatter page #1133

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

fix typos in the new xcodebuild formatter page #1133

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b15e98d
Fix typos.
rogerluan Jan 22, 2022
a0f6bec
Fix typos
janbrasna Feb 24, 2022
e2777e6
Improve wording.
rogerluan Feb 24, 2022
83aaed8
#1142 fix more typos in the new xcodebuild formatter page
rogerluan Feb 24, 2022
40a1948
Update list wording.
rogerluan Jul 3, 2022
d12799b
Merge branch 'master' into rogerluan-fix-typos
rogerluan Jul 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/best-practices/xcodebuild-formatters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ scan(
xcodebuild_formatter: "xcpretty"
)

# Specificy a local install of xcbeautify
# Specify a local install of xcbeautify
scan(
xcodebuild_formatter: "/custom/path/to/xcbeautify"
)

# Specifify your own custom formatter
# Specify your own custom formatter
scan(
xcodebuild_formatter: "/custom/path/to/my_formatter"
)
Expand All @@ -55,22 +55,22 @@ $ xcodebuild [flags] | <xcodebuild_formatter>
$ brew install xcbeautify
```

`xcbeautify` is the recommended because:
- Faster than `xcpretty`
- Supports Xcode's new build system output
- Supports Xcode's parallel testing output
- Supports formatting Swift Package Manager output
`xcbeautify` is currently recommended:

- It supports Xcode's new build system output
- It supports Xcode's parallel testing output
- It supports formatting Swift Package Manager output
- It's faster than `xcpretty`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- It's faster than `xcpretty`
- Is faster than `xcpretty`

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄 )

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
- 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…)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😊

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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;)


#### xcpretty

Historticaly, _fastlane_ was tightly integrated with [xcpretty](https://github.com/xcpretty/xcpretty). `xcpretty` is a RubyGem and a dependency of _fastlane_. This was the best option for _fastlane_ as there were no extra steps for installing or using this formatter.
Historically, _fastlane_ was tightly integrated with [xcpretty](https://github.com/xcpretty/xcpretty). `xcpretty` is a RubyGem and a dependency of _fastlane_. This was the best option for _fastlane_ as there were no extra steps for installing or using this formatter.

`xcpretty` also did more than formatting. It used the `xcodebuild` output to:

- Generate a JUnit report
- Generate an HTML report
- Generate a JSON compilation database

**Before 2.201.0**, [_scan_](/actions/scan/) used `xcpretty` to generate these files and determine success/failure with `xcpretty` output
<br/>**As of 2.201.0**, [_scan_](/actions/scan/) will only generate these if `xcodebuild_formatter` is using `xcpretty` but now use `trainer` to parse test results to determine success/failure
**Before 2.201.0**, [_scan_](/actions/scan/) used `xcpretty` to generate these files and determine success/failure with `xcpretty` output.<br/>
**As of 2.201.0**, [_scan_](/actions/scan/) will only generate these if `xcodebuild_formatter` is using `xcpretty` but now use `trainer` to parse test results to determine success/failure.