Nix language basics RITZA edit #6
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I have read the CLA Document and I hereby sign the CLA. |
fricklerhandwerk
force-pushed
the
nix-language-tutorial
branch
from
c51efd6 to
4a18a5f
Compare
fricklerhandwerk
approved these changes
Dec 8, 2022
| @@ -16,7 +16,7 @@ Notable uses of the Nix language are: | |||
|
|
|||
| A Linux distribution that can be configured fully declaratively and is based on Nix and Nixpkgs. | |||
|
|
|||
| Its underlying modular configuration system is written in the Nix language, and uses packages from Nixpkgs. | |||
| Its underlying modular configuration system is written in the Nix language and uses packages from Nixpkgs. | |||
There was a problem hiding this comment.
The comma was for emphasis.
| @@ -65,7 +65,7 @@ See the [Nix manual][manual-language] for a full language reference. | |||
| - Familiar with functional programming: 1 hour | |||
| - Proficient with functional programming: 30 minutes | |||
|
|
|||
| We recommend to run all examples. | |||
| We recommend you run all examples. | |||
There was a problem hiding this comment.
Suggested change
| We recommend you run all examples. | |
| We recommend running all examples. |
Does that fit better?
|
|
||
| :::{important} | ||
| A build task in Nix is called a *derivation*. | ||
| ::: | ||
|
|
||
| The Nix language has only few basic constructs which can be combined arbitrarily: | ||
| The Nix language has a few basic constructs which can be combined arbitrarily: |
There was a problem hiding this comment.
Suggested change
| The Nix language has a few basic constructs which can be combined arbitrarily: | |
| The Nix language has a small number of basic constructs which can be combined arbitrarily: |
Does that convey the meaning more precisely? I want to emphasize "there are not many of them", not colloquially "there are only a couple of them".
| @@ -433,7 +433,7 @@ Counter-example: | |||
| (let)= | |||
| ### `let ... in ...` | |||
|
|
|||
| Also known as “`let` expression” or “`let` binding” | |||
| Also known as "`let` expression" or "`let` binding" | |||
There was a problem hiding this comment.
The original is typographically correct. It's just more annoying to edit.
| @@ -934,7 +934,7 @@ For example, `<nixpkgs/lib>` points to the subdirectory `lib` of that file syste | |||
|
|
|||
| /nix/var/nix/profiles/per-user/root/channels/nixpkgs/lib | |||
|
|
|||
| While you will see many such examples, we recommend to [avoid search paths](search-path) in practice, as they are [impurities](impurities) which are not reproducible. | |||
| While you will see many such examples, we recommend you [avoid search paths](search-path) in practice, as they are [impurities](impurities), which are not reproducible. | |||
There was a problem hiding this comment.
Suggested change
| While you will see many such examples, we recommend you [avoid search paths](search-path) in practice, as they are [impurities](impurities), which are not reproducible. | |
| While you will see many such examples, we recommend [avoiding search paths](search-path) in practice, as they are [impurities](impurities), which are not reproducible. |
|
|
||
| Nix functions take exactly one argument. | ||
| Multiple arguments can be handled by nesting functions. | ||
|
|
||
| Such a nested function can be used like a function that takes multiple arguments, but offers additional flexibility. | ||
| Such a nested function can be used like a function that takes multiple arguments but offers additional flexibility. |
There was a problem hiding this comment.
I find this makes it harder to parse the sentence.
| @@ -1304,14 +1304,14 @@ You need to know about both to understand and navigate Nix language code. | |||
|
|
|||
| <!-- TODO: find a place for operators --> | |||
|
|
|||
| We recommend to at least skim them to familiarise yourself with what is available. | |||
| We recommend to at least skim them to familiarize yourself with what is available. | |||
| ::: | ||
|
|
||
| <details><summary>Detailed explanation</summary> | ||
|
|
||
| The example imports the Nix expression from the search path `<nixpkgs>`, and applies the resulting function to an empty attribute set `{}`. | ||
| The example imports the Nix expression from the search path `<nixpkgs>` and applies the resulting function to an empty attribute set `{}`. |
There was a problem hiding this comment.
This is a sequence, not parallel. I'm not super strong on English grammar and placing commas, but removing that one feels it would distort the meaning.
| @@ -1804,16 +1804,16 @@ Explanation: | |||
|
|
|||
| To get things done: | |||
|
|
|||
| - [](declarative-reproducible-envs) – create reproducible shell environments from a Nix file | |||
| - [Declarative and reproducible developer environments](declarative-reproducible-envs) – create reproducible shell environments from a Nix file | |||
There was a problem hiding this comment.
The title will be filled automatically.
Comment on lines
+1815
to
+1816
| - the data type of a named value or function argument, | ||
| - the data type a called function accepts for its argument, or |
There was a problem hiding this comment.
This is not required grammatically and makes the list harder to parse for no good reason.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.