mirror of
https://github.com/servo/servo.git
synced 2025-06-06 16:45:39 +00:00
Adjust the language used in some of the documentation (#31583)
* fixed a typo in the Android setup command * Fix typo in documentation for command-line arguments * Fix style and formatting issues in the Shell Scripts section of the documentation * Update style.md * Fixed various inconsistencies * Fixed various inconsistencies * Update webxr.md * Update style.md * Update COMMAND_LINE_ARGS.md * Update README.md Co-authored-by: Martin Robinson <mrobinson@igalia.com> * Update docs/COMMAND_LINE_ARGS.md --------- Co-authored-by: Martin Robinson <mrobinson@igalia.com>
This commit is contained in:
parent
7e8a1503ba
commit
0327d4638b
5 changed files with 21 additions and 21 deletions
|
@ -5,10 +5,10 @@ automated linters. This document has guidelines that are less easy to lint for.
|
|||
|
||||
## Shell scripts
|
||||
|
||||
Shell scripts are OK for small tasks or wrappers, but prefer to use Python for
|
||||
Shell scripts are suitable for small tasks or wrappers, but it's preferable to use Python for
|
||||
anything with a hint of complexity or in general.
|
||||
|
||||
Shell scripts should be written against bash, starting with this shebang:
|
||||
Shell scripts should be written using bash, starting with this shebang:
|
||||
```
|
||||
#!/usr/bin/env bash
|
||||
```
|
||||
|
@ -23,7 +23,7 @@ set -o nounset
|
|||
set -o pipefail
|
||||
```
|
||||
|
||||
Quote all variables, using the full form: `"${SOME_VARIABLE}"`.
|
||||
Rememeber to quote all variables, using the full form: `"${SOME_VARIABLE}"`.
|
||||
|
||||
Use `"$(some-command)"` instead of backticks for command substitution. Note
|
||||
that these should be quoted as well.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue