33## Goals
44
55Purpose of this document is to provide a clear direction to ** help design
6- delightful command line** experience. This document contain guidelines to
6+ delightful command line** experience. This document contains guidelines to
77follow to ensure a consistent and approachable user experience.
88
99## Overview
@@ -115,7 +115,7 @@ The rules are:
115115
116116- Help is shown by using ` --help ` or ` help ` command (eg ` nix ` ` --``help ` or
117117 ` nix help ` ).
118- - For non-COMMANDs (eg. ` nix ` ` --``help ` and ` nix store ` ` --``help ` ) we ** show
118+ - For non-COMMANDs (eg. ` nix ` ` --``help ` and ` nix store ` ` --``help ` ) we ** show
119119 a summary** of most common use cases. Summary is presented on the STDOUT
120120 without any use of PAGER.
121121- For COMMANDs (eg. ` nix init ` ` --``help ` or ` nix help init ` ) we display the
@@ -230,8 +230,8 @@ Now **Learn** part of the output is where you educate users. You should only
230230show it when you know that a build will take some time and not annoy users of
231231the builds that take only few seconds.
232232
233- Every feature like this should go though a intensive review and testing to
234- collect as much a feedback as possible and to fine tune every little detail. If
233+ Every feature like this should go through an intensive review and testing to
234+ collect as much feedback as possible and to fine tune every little detail. If
235235done right this can be an awesome features beginners and advance users will
236236love, but if not done perfectly it will annoy users and leave bad impression.
237237
@@ -272,11 +272,11 @@ not know which `ARGUMENTS` and `OPTIONS` are required or which values are
272272possible for those options.
273273
274274In cases, the user might not provide the input or they provide wrong input,
275- rather then show the error, prompt a user with an option to find and select
275+ rather than show the error, prompt a user with an option to find and select
276276correct input (see examples).
277277
278278Prompting is of course not required when TTY is not attached to STDIN. This
279- would mean that scripts wont need to handle prompt, but rather handle errors.
279+ would mean that scripts won ' t need to handle prompt, but rather handle errors.
280280
281281A place to use prompt and provide user with interactive select
282282
@@ -300,7 +300,7 @@ going to happen.
300300```shell
301301$ nix build --option substitutors https://cache.example.org
302302------------------------------------------------------------------------
303- Warning! A security related question need to be answered.
303+ Warning! A security related question needs to be answered.
304304------------------------------------------------------------------------
305305 The following substitutors will be used to in `my-project`:
306306 - https://cache.example.org
@@ -311,14 +311,14 @@ $ nix build --option substitutors https://cache.example.org
311311
312312# Output
313313
314- Terminal output can be quite limiting in many ways. Which should forces us to
314+ Terminal output can be quite limiting in many ways. Which should force us to
315315think about the experience even more. As with every design the output is a
316316compromise between being terse and being verbose, between showing help to
317317beginners and annoying advance users. For this it is important that we know
318318what are the priorities.
319319
320320Nix command line should be first and foremost written with beginners in mind.
321- But users wont stay beginners for long and what was once useful might quickly
321+ But users won ' t stay beginners for long and what was once useful might quickly
322322become annoying. There is no golden rule that we can give in this guideline
323323that would make it easier how to draw a line and find best compromise.
324324
@@ -508,7 +508,7 @@ can, with a few key strokes, be changed into and advance introspection tool.
508508
509509### Progress
510510
511- For longer running commands we should provide and overview of the progress.
511+ For longer running commands we should provide and overview the progress.
512512This is shown best in `nix build` example:
513513
514514```shell
@@ -553,7 +553,7 @@ going to happen.
553553```shell
554554$ nix build --option substitutors https://cache.example.org
555555------------------------------------------------------------------------
556- Warning! A security related question need to be answered.
556+ Warning! A security related question needs to be answered.
557557------------------------------------------------------------------------
558558 The following substitutors will be used to in `my-project`:
559559 - https://cache.example.org
0 commit comments