Skip to content

Commit

Permalink
docs: fix typing errors (#426)
Browse files Browse the repository at this point in the history
  • Loading branch information
FarukhS52 authored Oct 31, 2023
1 parent 25bcaa8 commit 6e10042
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ And then restart the shell or source the shell config file.

## Install from source

`pixi` is 100% written in Rust and therefore it can be installed, build and tested with cargo.
`pixi` is 100% written in Rust and therefore it can be installed, built and tested with cargo.
To start using `pixi` from a source build run:

```shell
Expand All @@ -130,11 +130,11 @@ it's [compile steps](https://github.com/mamba-org/rattler/tree/main#give-it-a-tr
To uninstall the pixi binary should be removed.
Delete `pixi` from the `$PIXI_DIR` which is default to `~/.pixi/bin/pixi`

So on linux its:
So on Linux its:
```shell
rm ~/.pixi/bin/pixi
```
and on windows:
and on Windows:
```shell
$PIXI_BIN = "$Env:LocalAppData\pixi\bin\pixi"; Remove-Item -Path $PIXI_BIN
```
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/advanced_tasks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The tasks will be executed after each other:
- Then `build` as it only depends on `configure`.
- Then `start` as all it dependencies are run.

If one of the commands fail (exit with non-zero code.) it will stop and the next once will not be started.
If one of the commands fails (exit with non-zero code.) it will stop and the next one will not be started.

With this logic you can also create aliases as you don't have to specify any command in a task.

Expand Down Expand Up @@ -157,7 +157,7 @@ Next to running actual executable like `./myprogram`, `cmake` or `python` the sh
- **Boolean list:** use `&&` or `||` to separate two commands.
- `&&`: if the command before `&&` succeeds continue with the next command.
- `||`: if the command before `||` fails continue with the next command.
- **Sequential lists:** use `;` to run two commands without checking if the fist command failed or succeeded.
- **Sequential lists:** use `;` to run two commands without checking if the first command failed or succeeded.
- **Environment variables:**
- Set env variable using: `export ENV_VAR=value`
- Use env variable using: `$ENV_VAR`
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/explain_info_command.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Target platforms : linux-64

#### Options

- `--extended`: Gives more information that would otherwise be to slow for command.
- `--extended`: Gives more information that would otherwise be too slow for command.
This shows the sizes of the directories.
- `--json`: Get a machine-readable version of the information as output.

Expand All @@ -58,7 +58,7 @@ In that case, if pixi cannot find the `__cuda` virtual package on your machine t

### Cache dir

Pixi caches all previous downloaded packages in a cache folder.
Pixi caches all previously downloaded packages in a cache folder.
This cache folder is shared between all pixi projects and globally installed tools.
Normally the locations would be:

Expand Down
2 changes: 1 addition & 1 deletion docs/basic_usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ You've just learned the basic features of pixi:
2. adding a task, and executing it.
3. running a program.
Feel free to play around with what you just learned like adding more tasks, dependencies or code.
If you want to learn more checkout out our [in-depth documentation](./advanced)
If you want to learn more check out our [in-depth documentation](./advanced)

Happy coding!

Expand Down
8 changes: 4 additions & 4 deletions docs/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ name = "project-name"
### `version` (optional)
The version of the project.
This should be a valid version based on the conda Version Spec.
See the [version documentation](https://docs.rs/rattler_conda_types/latest/rattler_conda_types/struct.Version.html), for an explanation what is allowed in a Version Spec.
See the [version documentation](https://docs.rs/rattler_conda_types/latest/rattler_conda_types/struct.Version.html), for an explanation of what is allowed in a Version Spec.
```toml
[project]
version = "1.2.3"
Expand Down Expand Up @@ -126,7 +126,7 @@ documentation = "https://pixi.sh"
Tasks are a way to automate certain custom commands in your project.
For example: a `lint` or `format` step.
Tasks in a pixi project are essentially cross-platform shell commands, with a unified syntax across platforms.
For the more in-depth information check the [Advanced tasks documentation](advanced/advanced_tasks).
For more in-depth information check the [Advanced tasks documentation](advanced/advanced_tasks).
Pixi tasks are run in a pixi environment using `pixi run` and are executed using the [`deno_task_shell`](advanced/advanced_tasks#our-task-runner-deno_task_shell).

```toml
Expand Down Expand Up @@ -193,7 +193,7 @@ linux = "4.12.14"
```

## The `dependencies` table(s)
This section defines what dependencies you would like to use your project.
This section defines what dependencies you would like to use for your project.

There are multiple dependencies tables.
The default is `[dependencies]`, which are dependencies that are shared across platforms.
Expand Down Expand Up @@ -303,7 +303,7 @@ E.g `[target.linux-64.dependencies]`
The platform can be any of the target [platforms](#platforms) but must also be defined there.
The sub-table can be any of the specified above.

To make it a bit more clear, lets look at an example below.
To make it a bit more clear, let's look at an example below.
Currently, pixi combines the top level tables like `dependencies` with the target-specific ones into a single set.
Which, in the case of dependencies, can both add or overwrite dependencies.
In the example below, we have `cmake` being used for all targets but on `osx-64` a different version of python will be selected.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ You've just learned the basic features of pixi:
2. adding a task, and executing it.
3. running a program.
Feel free to play around with what you just learned like adding more tasks, dependencies or code.
If you want to learn more checkout out our [in-depth documentation](./advanced)
If you want to learn more check out our [in-depth documentation](./advanced)

Happy coding!

Expand Down
2 changes: 1 addition & 1 deletion docs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The installer will download pixi and add it to the path.

### Install from source

pixi is 100% written in Rust, and therefore it can be installed, build and tested with cargo.
pixi is 100% written in Rust, and therefore it can be installed, built and tested with cargo.
To start using pixi from a source build run:

```shell
Expand Down

0 comments on commit 6e10042

Please sign in to comment.