Skip to content

Commit 0027cbd

Browse files
committed
treewide: fix typos and grammatical errors
1 parent 6298dda commit 0027cbd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+97
-100
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To manually test [redirects](./_redirects):
2929

3030
## Building the reference manuals
3131

32-
By default nix.dev builds without the various versions of the Nix reference manual, as that takes quite a while due to how it's currently implemented.
32+
By default, nix.dev builds without the various versions of the Nix reference manual, as that takes quite a while due to how it's currently implemented.
3333
To enable building the manuals:
3434

3535
```shell-session

source/acknowledgements/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ Many thanks to past contributors, who helped make Nix documentation what it is t
3838
- [@domenkozar](https://github.com/domenkozar) was a founding member and part of the team from 2022-05 to 2023-01.
3939
Domen originally started nix.dev, wrote many basic tutorials, and funded editorial work through [Cachix](https://www.cachix.org/).
4040
He helped bootstrap the documentation team, handed out permissions, and advised us on many aspects.
41-
Domen donated nix.dev to the NixOS Foundation 2023-07.
41+
Domen donated nix.dev to the NixOS Foundation in 2023-07.

source/concepts/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ Rolling releases follow [`master`](https://github.com/NixOS/nixpkgs/branches/all
6262

6363
Yes. There is:
6464

65-
- CPU architecture—great effort being made to avoid compilation of native instructions in favour of hardcoded supported ones.
65+
- CPU architecture—great effort is being made to avoid compilation of native instructions in favour of hardcoded supported ones.
6666
- System's current time/date.
6767
- The filesystem used for building (see also [`TMPDIR`](https://nix.dev/manual/nix/stable/command-ref/env-common.html#env-TMPDIR)).
6868
- Linux kernel parameters, such as:
6969
- [IPv6 capabilities](https://github.com/NixOS/nix/issues/5615).
7070
- binfmt interpreters, e.g., those configured with [`boot.binfmt.emulatedSystems`](https://search.nixos.org/options?show=boot.binfmt.emulatedSystems).
71-
- Timing behaviour of the build system—parallel Make build does not get the correct inputs in some cases.
71+
- Timing behaviour of the build system—a parallel Make build may not get the correct inputs in some cases.
7272
- Insertion of random values, e.g., from `/dev/random` or `/dev/urandom`.
7373
- Differences between Nix versions. For instance, a new Nix version might introduce a new environment variable. A statement like `env > $out` is not promised by Nix to result in the same output, going into the future.

source/concepts/flakes.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,23 +42,23 @@ Nix handles flakes differently than regular {term}`Nix files <Nix file>` in the
4242

4343
- No external variables, parameters, or impure language values are allowed.
4444

45-
It means full reproducibility of a Nix expression, and, by extension, the resulting build instructions by default, but also prohibits parameterisation of results by consumers.
45+
It means full reproducibility of a Nix expression, and, by extension, the resulting build instructions by default, but also prohibits parametrisation of results by consumers.
4646

4747
(flakes-controversy)=
4848
## Why are flakes controversial?
4949

5050
[Flakes](flakes-definition) were inspired by [Shea Levy's NixCon 2018 talk](https://www.youtube.com/watch?v=DHOLjsyXPtM), formally proposed in [RFC 49](https://github.com/NixOS/rfcs/pull/49), and have been in development since 2019.
5151
Nix introduced the implementation as its first [experimental feature] in 2021.
5252

53-
The subject is considered controversial among Nix users and developers in terms of design, implementation quality, and decision making process.
53+
The subject is considered controversial among Nix users and developers in terms of design, implementation quality, and decision-making process.
5454
In particular:
5555
- The RFC was closed without conclusion, and some fundamental issues are not yet resolved.
5656
For example:
5757
- The notion of a [global flake registry](https://github.com/NixOS/flake-registry) saw [substantial criticism](https://github.com/NixOS/rfcs/pull/49#issuecomment-635635333) that was never addressed.
5858
While the source references of [registry entries can be pinned](https://nix.dev/manual/nix/stable/command-ref/new-cli/nix3-registry-pin), local registry names in Nix expressions [introduce mutable system state](https://github.com/NixOS/nix/issues/7422) and are thus, in that regard, no improvement over channels as managed by [`nix-channel`](https://nix.dev/manual/nix/stable/command-ref/nix-channel).
59-
- It is [impossible to parameterise flakes](https://github.com/NixOS/nix/issues/2861).
59+
- It is [impossible to parametrise flakes](https://github.com/NixOS/nix/issues/2861).
6060
This means that [flakes downgrade ease of use of the `system` parameter](https://github.com/NixOS/nix/issues/3843) of derivations, for producers and consumers.
61-
- the flakes proposal was criticised for [trying to solve too many problems at once](https://github.com/nixos/rfcs/pull/49#issuecomment-521998933) and [at the wrong abstraction layer](https://discourse.nixos.org/t/nixpkgs-cli-working-group-member-search/30517).
61+
- the flakes' proposal was criticised for [trying to solve too many problems at once](https://github.com/nixos/rfcs/pull/49#issuecomment-521998933) and [at the wrong abstraction layer](https://discourse.nixos.org/t/nixpkgs-cli-working-group-member-search/30517).
6262
Part of this is that [the new command line interface and flakes are closely tied to each other](https://discourse.nixos.org/t/2023-03-06-nix-team-meeting-minutes-38/26056#cli-stabilisation-announcement-draft-4).
6363
- As [predicted by RFC reviewers](https://github.com/NixOS/rfcs/pull/49#issuecomment-588990425), the original implementation introduced [regressions](https://discourse.nixos.org/t/nix-2-4-and-what-s-next/16257) in the [Nix 2.4 release](https://nix.dev/manual/nix/stable/release-notes/rl-2.4.html), breaking some stable functionality without a [major version](https://semver.org/) increment.
6464
- Copying sources to the Nix store prior to evaluation adds a [significant performance penalty](https://github.com/NixOS/nix/issues/3121), especially for large repositories such as {term}`Nixpkgs`.
@@ -75,7 +75,7 @@ As of the [2023](https://discourse.nixos.org/t/nix-community-survey-2023-results
7575

7676
You have to judge for yourself based on your needs.
7777

78-
[Flakes](flakes-definition) emphasize reproducible artifacts and convenience for their consumers, while classic Nix tools center around composable building blocks and customisation options for developers.
78+
[Flakes](flakes-definition) emphasize reproducible artifacts and convenience for their consumers, while classic Nix tools center around composable building blocks and customization options for developers.
7979
Both paradigms have their own set of unique concepts and support tooling that have to be learned, with varying ease of use, implementation quality, and support status.
8080
At the moment, neither the stable nor the experimental interface is clearly superior to the other in all aspects.
8181

@@ -89,13 +89,13 @@ Flakes and the `nix` command suite bring multiple improvements that are relevant
8989
At the same time, flakes have [fundamental architectural issues](flakes-controversy) and a number of [problems with the implementation](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+label%3Aflakes+sort%3Areactions-%2B1-desc), and there is no coordinated effort to resolve them systematically.
9090
There are also still many [open design questions around the `nix` command line interface](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+label%3Anew-cli+sort%3Areactions-%2B1-desc), some of which are currently being worked on.
9191

92-
While flakes reduce complexity in some regards, they also introduce some with additional mechanisms.
92+
While flakes reduce complexity in some regards, they also introduce some complexity with additional mechanisms.
9393
You will have to learn more about the system to fully understand how it works.
9494

9595
Other than that, and below the surface of the flake schema, Nix and the Nix language work exactly the same in both cases.
9696
In principle, the same level of reproducibility can be achieved with or without flakes.
9797
In particular, the process of adding software to {term}`Nixpkgs` or maintaining {term}`NixOS` modules and configurations is not affected by flakes at all.
98-
There is also no evidence that flakes could help solving the scalability challenges of either.
98+
There is also no evidence that flakes could help solve the scalability challenges of either.
9999

100100
Finally, there are downsides to relying on [experimental features][experimental feature] in general:
101101

source/concepts/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
(concepts)=
22
# Concepts
33

4-
These sections contains explanations of history and ideas in the Nix ecosystem.
4+
This section contains explanations of history and ideas in the Nix ecosystem.
55

66
```{toctree}
77
:glob:

source/contributing/documentation/diataxis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ We aim to build our documentation according to the [Diátaxis framework for tech
55
- [Tutorials](#tutorials)
66
- [Guides](#guides)
77
- [Reference](#reference)
8-
- [Concept](#concepts)
8+
- [Concepts](#concepts)
99

10-
We've found that contributors struggle to understand the differences between these categories, and while we _strongly_ recommend reading up on the Diataxis framework, we can summarize them as follows:
10+
We've found that contributors struggle to understand the differences between these categories, and while we _strongly_ recommend reading up on the Diátaxis framework, we can summarize them as follows:
1111

1212
## Reference
1313

@@ -62,7 +62,7 @@ The pilot-in-training needs practice knowing when to deploy the landing gear, wh
6262
Actually landing the plane during the flight simulation is less important than learning the individual skills that make up a successful landing.
6363
This is the context for a tutorial.
6464

65-
Finally, one last way of thinking about the difference between How-to Guide and Tutorial is like this:
65+
Finally, one last way of thinking about the difference between a how-to guide and a tutorial is like this:
6666
- Guide: "step 1: do this, step 2: do that, etc"
6767
- Tutorial: "take my hand as I show you how to do this"
6868

source/contributing/documentation/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing documentation
22

3-
Thank you for your interest to help improve documentation in the Nix ecosystem!
3+
Thank you for your interest in helping improve documentation in the Nix ecosystem!
44
This project would not be possible without your support.
55

66
## Getting started
@@ -40,7 +40,7 @@ Please share your experience to help us improve upstream documentation and begin
4040
If you are proficient in applying Nix to a domain-specific problem, and want to share your expertise on best practices, please check the existing content.
4141
- Does existing material on your subject meet your standards?
4242
- How could we improve it?
43-
- Is there a popular application of Nix' capabilities not yet covered?
43+
- Is there a popular application of Nix's capabilities not yet covered?
4444
- We would be glad to incorporate your insights.
4545

4646
## Licensing and attribution

source/contributing/documentation/resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation resources
22

3-
This is an overview of documentation resources for Nix, Nixpkgs, and NixOS, with suggestions how you can help to improve them.
3+
This is an overview of documentation resources for Nix, Nixpkgs, and NixOS, with suggestions for how you can help to improve them.
44

55
## Reference manuals
66

source/contributing/documentation/style-guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ This document outlines the guidelines we use when writing documentation.
1010
>
1111
> [Blaise Pascal](https://en.m.wikiquote.org/w/index.php?title=Blaise_Pascal&oldid=2978584#Quotes)
1212
13-
Readers' time and attention is limited.
14-
Take the time to be extraordinarily respectful with their cognitive resources.
13+
Readers' time and attention are limited.
14+
Take the time to be extraordinarily respectful of their cognitive resources.
1515

1616
The same holds for communication directed to contributors and maintainers:
1717
This is a public project, and many people will read what you write.
@@ -27,7 +27,7 @@ Use this leverage with care.
2727

2828
> Add the `python310` package to `buildInputs`.
2929
30-
Don't use a conversational tone, as it distracts from the contents.
30+
Don't use a conversational tone, as it distracts from the content.
3131
For example, don't write:
3232

3333
> Going forward, let's now add the `python310` package to `buildInputs` as we have seen in the previous tutorial.
@@ -110,7 +110,7 @@ Set off a [fork bomb](https://en.wikipedia.org/wiki/Fork_bomb):
110110
```
111111

112112
:::{dropdown} Detailed explanation
113-
This Bash command defines and executes a function `:` that recursively spawns copies of itself, quickly consuming system resources
113+
This Bash command defines and executes a function `:` that recursively spawns copies of itself, quickly consuming system resources.
114114
:::
115115
````
116116
::::
@@ -126,10 +126,10 @@ If that's not possible, break the example down into multiple parts, explain them
126126

127127
Code samples that are _intended_ to work should work.
128128

129-
If you are going to present an example that does not work (e.g. you're illustrating a common mistake) explain so beforehand.
129+
If you are going to present an example that does not work (e.g. you're illustrating a common mistake) explain this beforehand.
130130
Many readers will get stuck trying to make example code work without reading ahead to find out that the code isn't intended to work.
131131

132-
Code samples should all include a programming language when applicable for syntax highlighting when rendered e.g.
132+
Code samples should all include a programming language when applicable for syntax highlighting when rendered, e.g.:
133133

134134
````
135135
```python
@@ -142,7 +142,7 @@ print("Hello, World!")
142142
Reserve the largest header (`#`) for the title.
143143

144144
Use Markdown headers `##` through `###` to divide up content in the body of the document.
145-
Finer grained headings are not necessarily better.
145+
Finer-grained headings are not necessarily better.
146146

147147
### One line per sentence
148148

source/contributing/documentation/writing-a-tutorial.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@ Most of that time is typically spent collaboratively:
2424
- Ensuring that the instructions are neither too sparse nor too dense for learners
2525
- Finding ever-more succinct and clear ways to convey ideas
2626

27-
Follow these steps to avoid re-doing work
27+
Follow these steps to avoid redoing work
2828

2929
### Pick a topic
3030

3131
There is a [tracking issue](https://github.com/NixOS/nix.dev/issues/572) for tutorials that the documentation team has decided should exist as part of the tutorial series.
3232
Pick an issue that covers a topic that you're either knowledgeable about or have a particular interest in.
3333

34-
Check referenced issues and pull request to make sure you won't duplicate work that someone else has already started!
34+
Check referenced issues and pull requests to make sure you won't duplicate work that someone else has already started!
3535

3636
There are more [tutorial requests](https://github.com/NixOS/nix.dev/issues?q=is%3Aopen+is%3Aissue+label%3Atutorial) than captured in the outline.
3737
[Open a new issue](https://github.com/NixOS/nix.dev/issues/new?&template=tutorial.md) if what you wanted to work on isn't tracked anywhere.
3838
This is an opportunity for you to clarify your goals, and an opportunity for everyone else to find out that there's interest in that subject.
3939

40-
### Submit an pull request with an outline
40+
### Submit a pull request with an outline
4141

4242
Submit a pull request with an outline of the tutorial following [our recommended structure](#structure).
4343
The outline should contain bullet points on each section's content.
@@ -57,7 +57,7 @@ Revise your tutorial based on the detailed feedback.
5757
We recommend testing your tutorial with friends or coworkers.
5858
This will both help with revealing implicit prerequisites as well as provide a realistic estimate of the reading time.
5959

60-
In a final review will check that everything is technically correct.
60+
A final review will check that everything is technically correct.
6161

6262
## Structure
6363

@@ -74,7 +74,7 @@ The learning goal of a tutorial is always acquiring a skill, which is distinguis
7474
### What do you need?
7575

7676
State the prerequisite knowledge and skills.
77-
The tutorial should always be written such that the stated prerequisites are sufficient to achieve learning goals.
77+
The tutorial should always be written such that the stated prerequisites are sufficient to achieve the learning goals.
7878

7979
Examples:
8080

@@ -111,7 +111,7 @@ Depending on how well a use case is explored, point the reader to
111111
- guides or other tutorials
112112
- links to known-good external resources, with summaries
113113
- overview of available support tools, and their state of maturity and maintenance
114-
- overview of ideas, and state of community discussion.
114+
- overview of ideas, and the state of community discussion.
115115

116116
We recommend making an explicit separation of practical from theoretical learning resources, as then readers will be able to quickly decide to either get things done or learn more.
117117

0 commit comments

Comments
 (0)