lunaphied/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

fix many doc typos

Browse source
This commit is contained in:
Kevin Amado 2021-11-13 22:28:20 -05:00
parent bceda30498
commit eae54f2d52
No known key found for this signature in database
GPG key ID: FFF341057F503148
3 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/manual/src/contributing/cli-guideline.md
View file

@ -103,7 +103,7 @@ impacted the most by bad user experience.
# Help is essential # Help is essential
Help should be built into your command line so that new users can gradually Help should be built into your command line so that new users can gradually
discover new features when they need them. discover new features when they need them.
## Looking for help ## Looking for help
@ -176,7 +176,7 @@ $ nix init --template=template#pyton
------------------------------------------------------------------------ ------------------------------------------------------------------------
Initializing Nix project at `/path/to/here`. Initializing Nix project at `/path/to/here`.
Select a template for you new project: Select a template for you new project:
|> template#pyton |> template#python
template#python-pip template#python-pip
template#python-poetry template#python-poetry
``` ```
@ -237,7 +237,7 @@ love, but if not done perfectly it will annoy users and leave bad impression.
# Input # Input
Input to a command is provided via `ARGUMENTS` and `OPTIONS`. Input to a command is provided via `ARGUMENTS` and `OPTIONS`.
`ARGUMENTS` represent a required input for a function. When choosing to use `ARGUMENTS` represent a required input for a function. When choosing to use
`ARGUMENTS` over `OPTIONS` please be aware of the downsides that come with it: `ARGUMENTS` over `OPTIONS` please be aware of the downsides that come with it:
@ -302,7 +302,7 @@ $ nix build --option substitutors https://cache.example.org
------------------------------------------------------------------------ ------------------------------------------------------------------------
Warning! A security related question needs to be answered. Warning! A security related question needs to be answered.
------------------------------------------------------------------------ ------------------------------------------------------------------------
The following substitutors will be used to in `my-project`: The following substitutors will be used to in `my-project`:
- https://cache.example.org - https://cache.example.org
Do you allow `my-project` to use above mentioned substitutors? Do you allow `my-project` to use above mentioned substitutors?
@ -342,7 +342,7 @@ also allowing them to redirect content to a file. For example:
```shell ```shell
$ nix build > build.txt $ nix build > build.txt
------------------------------------------------------------------------ ------------------------------------------------------------------------
Error! Atrribute `bin` missing at (1:94) from string. Error! Attribute `bin` missing at (1:94) from string.
------------------------------------------------------------------------ ------------------------------------------------------------------------
1| with import <nixpkgs> { }; (pkgs.runCommandCC or pkgs.runCommand) "shell" { buildInputs = [ (surge.bin) ]; } "" 1| with import <nixpkgs> { }; (pkgs.runCommandCC or pkgs.runCommand) "shell" { buildInputs = [ (surge.bin) ]; } ""
@ -408,7 +408,7 @@ Above command clearly states that command successfully completed. And in case
of `nix build`, which is a command that might take some time to complete, it is of `nix build`, which is a command that might take some time to complete, it is
equally important to also show that a command started. equally important to also show that a command started.
## Text alignment ## Text alignment
Text alignment is the number one design element that will present all of the Text alignment is the number one design element that will present all of the
Nix commands as a family and not as separate tools glued together. Nix commands as a family and not as separate tools glued together.
@ -419,7 +419,7 @@ The format we should follow is:
$ nix COMMAND $ nix COMMAND
VERB_1 NOUN and other words VERB_1 NOUN and other words
VERB__1 NOUN and other words VERB__1 NOUN and other words
|> Some details |> Some details
``` ```
Few rules that we can extract from above example: Few rules that we can extract from above example:
@ -444,13 +444,13 @@ is not even notable, therefore relying on it wouldn’t make much sense.
**The bright text is much better supported** across terminals and color **The bright text is much better supported** across terminals and color
schemes. Most of the time the difference is perceived as if the bright text schemes. Most of the time the difference is perceived as if the bright text
would be bold. would be bold.
## Colors ## Colors
Humans are already conditioned by society to attach certain meaning to certain Humans are already conditioned by society to attach certain meaning to certain
colors. While the meaning is not universal, a simple collection of colors is colors. While the meaning is not universal, a simple collection of colors is
used to represent basic emotions. used to represent basic emotions.
Colors that can be used in output Colors that can be used in output
@ -555,7 +555,7 @@ $ nix build --option substitutors https://cache.example.org
------------------------------------------------------------------------ ------------------------------------------------------------------------
Warning! A security related question needs to be answered. Warning! A security related question needs to be answered.
------------------------------------------------------------------------ ------------------------------------------------------------------------
The following substitutors will be used to in `my-project`: The following substitutors will be used to in `my-project`:
- https://cache.example.org - https://cache.example.org
Do you allow `my-project` to use above mentioned substitutors? Do you allow `my-project` to use above mentioned substitutors?
@ -566,7 +566,7 @@ $ nix build --option substitutors https://cache.example.org
There are many ways that you can control verbosity. There are many ways that you can control verbosity.
Verbosity levels are: Verbosity levels are:
- `ERROR` (level 0) - `ERROR` (level 0)
- `WARN` (level 1) - `WARN` (level 1)
@ -586,4 +586,4 @@ There are also two shortcuts, `--debug` to run in `DEBUG` verbosity level and
# Appendix 1: Commands naming exceptions # Appendix 1: Commands naming exceptions
`nix init` and `nix repl` are well established `nix init` and `nix repl` are well established

2
doc/manual/src/expressions/builtins-prefix.md
View file

@ -12,5 +12,5 @@ For instance, `derivation` is also available as `builtins.derivation`.
<dl> <dl>
<dt><code>derivation <var>attrs</var></code>; <dt><code>derivation <var>attrs</var></code>;
<code>builtins.derivation <var>attrs</var></code></dt> <code>builtins.derivation <var>attrs</var></code></dt>
<dd><p><var>derivation</var> in described in <dd><p><var>derivation</var> is described in
<a href="derivations.md">its own section</a>.</p></dd> <a href="derivations.md">its own section</a>.</p></dd>

2
doc/manual/src/package-management/garbage-collection.md
View file

@ -44,7 +44,7 @@ collector as follows:
$ nix-store --gc $ nix-store --gc
``` ```
The behaviour of the gargage collector is affected by the The behaviour of the garbage collector is affected by the
`keep-derivations` (default: true) and `keep-outputs` (default: false) `keep-derivations` (default: true) and `keep-outputs` (default: false)
options in the Nix configuration file. The defaults will ensure that all options in the Nix configuration file. The defaults will ensure that all
derivations that are build-time dependencies of garbage collector roots derivations that are build-time dependencies of garbage collector roots