nushell / nushell/nushell.github.io

Add a chapter about errors

Open
#772 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
258
Forks
561
Avg merge
3h 20m
Merged PRs (30d)
15

Description

One concept that I still find quite hard to grasp are Nushell's errors.
As far as I can tell, they behave like raised exceptions in a language like Python.
They bubble up, but can be caught with try or do -i.
However, I haven't seen that spelled out yet.

I see that nushell errors are also created if external commands exit with a non-zero exit code.
But also that isn't mentioned in the book.

I would be happy to add a chapter about errors in Nushell if someone could me guide through the things I am unsure about.

Topics to cover:

  • behavior of errors
  • try
  • do
  • error make
  • complete

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named in the issue. Start by reviewing Nushell's documentation for errors, try, do -i, error make, and complete, then confirm how external non-zero exit codes behave; done means adding a chapter that clearly explains each listed topic.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.