extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-11-22 08:23:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

DOC: make the README of the standard library clearer (#8465)

Browse Source 
Should close #8444.

# Description
as asked by @presidento, i've used a generic command to run the tests.

i've also transformed the "a concrete example" sections into quote
blocks to make them stand out less.
not sure about that one, please tell me what you think 😋 

i think a small example is always helpfull, maybe some work has to be
done to make it better 💪

# User-Facing Changes
hopefully a slightly clearer README for the standard library

# Tests + Formatting
```
$nothing
```

# After Submitting
```
$nothing
```
This commit is contained in:
Antoine Stevan 2023-03-16 04:13:09 +01:00 committed by GitHub
parent 4b16406050
commit d3be5ec750
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
crates/nu-utils/standard_library/README.md
View File

@ -17,38 +17,38 @@ in order to "import" the standard library to either the interactive [*REPL*][REP
use /path/to/standard_library/std.nu
```
### :mag: a concrete example
- my name is @amtoine and i use the `ghq` tool to manage `git` projects
> **Note**
> `ghq` stores any repository inside `$env.GHQ_ROOT` under `<host>/<owner>/<repo>/`
- the path to my local fork of `nushell` is then defined as
```bash
let-env NUSHELL_REPO = ($env.GHQ_ROOT | path join "github.com" "amtoine" "nushell")
```
- and the full path to the standard library is defined as
```bash
let-env STD_LIB = ($env.NUSHELL_REPO | path join "crates" "nu-utils" "standard_library")
```
> see the content of `$env.STD_LIB` :yum:
> ### :mag: a concrete example
> - my name is @amtoine and i use the `ghq` tool to manage `git` projects
> > **Note**
> > `ghq` stores any repository inside `$env.GHQ_ROOT` under `<host>/<owner>/<repo>/`
> - the path to my local fork of `nushell` is then defined as
> ```bash
> >_ ls $env.STD_LIB | get name | str replace $env.STD_LIB "" | str trim -l -c "/"
> ╭───┬───────────╮
> │ 0 │ README.md │
> │ 1 │ std.nu │
> │ 2 │ tests.nu │
> ╰───┴───────────╯
> let-env NUSHELL_REPO = ($env.GHQ_ROOT | path join "github.com" "amtoine" "nushell")
> ```
> - and the full path to the standard library is defined as
> ```bash
> let-env STD_LIB = ($env.NUSHELL_REPO | path join "crates" "nu-utils" "standard_library")
> ```
> > see the content of `$env.STD_LIB` :yum:
> > ```bash
> > >_ ls $env.STD_LIB | get name | str replace $env.STD_LIB "" | str trim -l -c "/"
> > ╭───┬───────────╮
> > │ 0 │ README.md │
> > │ 1 │ std.nu │
> > │ 2 │ tests.nu │
> > ╰───┴───────────╯
> > ```
> - finally we can `use` the standard library and have access to the commands it exposes :thumbsup:
> ```bash
> >_ use std.nu
> >_ help std
> Module: std
>
> Exported commands:
> assert (std assert), assert eq (std assert eq), assert ne (std assert ne), match (std match)
>
> This module does not export environment.
> ```
- finally we can `use` the standard library and have access to the commands it exposes :thumbsup:
```bash
>_ use std.nu
>_ help std
Module: std
Exported commands:
assert (std assert), assert eq (std assert eq), assert ne (std assert ne), match (std match)
This module does not export environment.
```
## :pencil2: contribute to the standard library
### :wrench: add new commands
@ -59,9 +59,15 @@ This module does not export environment.
- add a call to `test_<feature>` at the bottom of the `main`
### :test_tube: run the tests
the following call should return nothing
the following call should return no errors
```bash
nu ($env.STD_LIB | path join "tests.nu")
nu /path/to/standard_library/tests.nu
```
> #### :mag: a concrete example
> with `STD_LIB` defined as in the example above
> ```bash
> nu ($env.STD_LIB | path join "tests.nu")
> ```
[REPL]: https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop