Skip to content

Commit d1b5bdb

Browse files
author
splint-disk-8i
authored
Fix misleading echo in swift-fmt-check target (#585)
Small documentation and Makefile fixes: - Makefile: swift-fmt-check echo says "Applying" but the target only checks/lints — changed to "Checking code formatting compliance" - README.md: "libraries surface" → "libraries' API surface" - README.md: "light weight" → "lightweight" (consistent with rest of doc) - README.md: "for use a default" → missing comma, grammar fix - CONTRIBUTING.md: "To clarify of what" → "To clarify what"
1 parent a59ed89 commit d1b5bdb

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,4 @@ AI tools should be used to **enhance, not replace** the human elements that make
113113

114114
## Code of conduct
115115

116-
To clarify of what is expected of our contributors and community members, the Containerization team has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities and articulates our values well. For more detail, please read the [Code of Conduct](https://github.com/apple/.github/blob/main/CODE_OF_CONDUCT.md "Code of Conduct").
116+
To clarify what is expected of our contributors and community members, the Containerization team has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities and articulates our values well. For more detail, please read the [Code of Conduct](https://github.com/apple/.github/blob/main/CODE_OF_CONDUCT.md "Code of Conduct").

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ swift-fmt:
139139
@$(SWIFT) format --recursive --configuration .swift-format -i $(SWIFT_SRC)
140140

141141
swift-fmt-check:
142-
@echo Applying the standard code formatting...
142+
@echo Checking code formatting compliance...
143143
@$(SWIFT) format lint --recursive --strict --configuration .swift-format-nolint $(SWIFT_SRC)
144144

145145
.PHONY: update-licenses

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Older versions of macOS are not supported.
4040

4141
## Example Usage
4242

43-
For examples of how to use some of the libraries surface, the cctl executable is a good start. This app is a useful playground for exploring the API. It contains commands that exercise some of the core functionality of the various products, such as:
43+
For examples of how to use the libraries' API surface, the cctl executable is a good start. This app is a useful playground for exploring the API. It contains commands that exercise some of the core functionality of the various products, such as:
4444

4545
1. [Manipulating OCI images](./Sources/cctl/ImageCommand.swift)
4646
2. [Logging in to container registries](./Sources/cctl/LoginCommand.swift)
@@ -54,7 +54,7 @@ Containerization provides an optimized kernel configuration located in the [kern
5454

5555
This directory includes a containerized build environment to easily compile a kernel for use with Containerization.
5656

57-
The kernel configuration is a minimal set of features to support fast start times and a light weight environment.
57+
The kernel configuration is a minimal set of features to support fast start times and a lightweight environment.
5858

5959
While this configuration will work for the majority of workloads we understand that some will need extra features.
6060
To solve this Containerization provides first class APIs to use different kernel configurations and versions on a per container basis.
@@ -124,7 +124,7 @@ make test integration
124124
```
125125

126126
A kernel is required to run integration tests.
127-
If you do not have a kernel locally for use a default kernel can be fetched using the `make fetch-default-kernel` target.
127+
If you do not have a kernel locally, a default kernel can be fetched using the `make fetch-default-kernel` target.
128128

129129
Fetching the default kernel only needs to happen after an initial build or after a `make clean`.
130130

0 commit comments

Comments
 (0)