Skip to content

Commit 238d634

Browse files
Apply suggestions from code review
Co-authored-by: Ethan Kusters <[email protected]>
1 parent 0d08cc0 commit 238d634

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -148,14 +148,16 @@ log in Xcode's report navigator and expanding the "Compile documentation" step.
148148
### Invoking `docc` from Swift Package Manager
149149

150150
You can also test a locally built version of Swift-DocC using Swift Package Manager
151-
CLI. SwiftPM will try to read `DOCC_EXEC` environment variable value, and use
151+
CLI. The Swift-DocC SwiftPM plugin will try to read `DOCC_EXEC` environment variable value, and use
152152
the path you provded if it's set.
153153
154-
1. In your test `Package.swift`, add a dependency on [`Swift-DocC Plugin`](https://github.com/apple/swift-docc-plugin).
155-
2. Set `DOCC_EXEC` environment variable and run documentation generation
156-
command like this:
154+
1. In your project's `Package.swift`, add a dependency on the [`Swift-DocC Plugin`](https://github.com/apple/swift-docc-plugin).
155+
2. Set the `DOCC_EXEC` environment variable and run the documentation generation
156+
command:
157157

158-
`DOCC_EXEC=/path/to/docc swift package generate-documentation`
158+
```bash
159+
DOCC_EXEC=/path/to/docc swift package generate-documentation
160+
```
159161

160162
## Using `docc` to build and preview documentation
161163

0 commit comments

Comments
 (0)