Skip to content

Commit

Permalink
fix: release please package name (#224)
Browse files Browse the repository at this point in the history
* docs: minor fixes to 29

* docs: minor refinements/fixes

* fix: correct the release-please package name
  • Loading branch information
dwmkerr authored Jul 5, 2022
1 parent 5ecc3eb commit 08bf4d6
Show file tree
Hide file tree
Showing 7 changed files with 3,197 additions and 731 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release-please.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
release-type: node
package-name: "Effective Shell"
package-name: effective-shell
# We include 'docs' in the changelog types, this means document
# changes will be in the CHANGELOG and also that docs changes will
# trigger a patch release. This is essential as we basically are
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ When the dollar symbol `$` is used, this indicates that the shell is going to pe

A lot of these expansions are covered in detail in [Chapter 19 - Variables, Reading Input, and Mathematics](../../04-shell-scripting/19-variables-reading-input-and-mathematics/index.md) but I have included each of the available expansions here for reference.

In it's most simple form, parameter expansion simple replaces the name of a variable or parameter with its value:
In its most simple form, parameter expansion simple replaces the name of a variable or parameter with its value:

```bash
fruit=apples
Expand Down Expand Up @@ -331,7 +331,7 @@ The output of this script is:
/home/dwmkerr
```

This can be very useful if you are writing scripts that will work with arbitrary of variable parameter names.
This can be very useful if you are writing scripts that will work with arbitrary or variable parameter names.

You can see more examples of how parameter expansion works, and in particular how to use parameter expansion with the parameters to functions or scripts in [Chapter 19 - Variables, Reading Input, and Mathematics](../../04-shell-scripting/19-variables-reading-input-and-mathematics/index.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ def search_for_word(word):
return first_definition
```

I'm not going to go through this blow-by-blow, it's a fairly rough and ready way to try and get the definition of a word from an online resource. In a nutshell it does the follow:
I'm not going to go through this blow-by-blow, it's a fairly rough and ready way to try and get the definition of a word from an online resource. In a nutshell it does the following:

1. Make sure that have the right address to search for the word
2. Search for the word and download the result
Expand Down Expand Up @@ -294,7 +294,7 @@ parser.add_argument(
args = parser.parse_args()
```

The `argparse` module is very sophisticated, you can read more about it online if you'd like to discover more. But for now its enough to know that this code defines an optional argument named `crop`, that can be provided with a number, or without a number. We'll see it in action shortly.
The `argparse` module is very sophisticated, you can read more about it online if you'd like to discover more. But for now, it's enough to know that this code defines an optional argument named `crop`, that can be provided with a number, or without a number. We'll see it in action shortly.

Next we'll add a function that writes a word and its definition in a nicer way:

Expand Down Expand Up @@ -409,7 +409,7 @@ There are all sorts of other features you could add as a coding and learning exe
- **Clearer interactive mode** - when stdin is a terminal, meaning the user is interactive, show a prompt and instructions
- **A verbose flag** - a `--verbose` flag to show detailed error messages if they are encountered

If you find yourself writing more complex command-line tools in Python, you might also explore the excellent [Click](https://click.palletsprojects.com/en/8.0.x/) Python package. This is a very popular package among Python developers and is used by a number of large and well-established projects. The [Typer](https://typer.tiangolo.com/) package is also worth exploring. The `urllib` package I have used works, but it can be quite unweildy when dealing with more complex options - many developers will prefer alternative packages.
If you find yourself writing more complex command-line tools in Python, you might also explore the excellent [Click](https://click.palletsprojects.com/en/8.0.x/) Python package. This is a very popular package among Python developers and is used by a number of large and well-established projects. The [Typer](https://typer.tiangolo.com/) package is also worth exploring. The `urllib` package I have used works, but it can be quite unwieldy when dealing with more complex options - many developers will prefer alternative packages.

## Summary

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There are some other reasons that being able to use a terminal editor is powerfu

**Speed of editing** - editors such as Vim and Emacs allow you to be _incredibly_ efficient at editing text, once you get over the initial learning curve. Vim in particular is designed to try and keep your fingers on the home row of the keyboard as much as possible to make it possible to manipulate text very quickly.

**Customisation** - terminal editors can be customised to suit your working style - you can then manage your customisations through dotfiles that you share across environments as described in [Chapter 26 - Managing Your Dotfiles](../../05-building-your-toolkit/26-managing-your-dotfiles).
**Customisation** - terminal editors can be customised to suit your working style - you can then manage your customisations through dotfiles that you share across environments as described in [Chapter 26 - Managing Your Dotfiles](../../05-building-your-toolkit/26-managing-your-dotfiles/index.md).

**Improving Efficiency in Graphical Editors and other tools** - if you learn how to use Vim or Emacs and find yourself able to edit text very efficiently using their idioms, then you can install plugins in your graphical editors or IDEs, allowing you to edit text using the same commands. There are even browser plugins that let you navigate webpages using Vim style movement commands.

Expand Down
4 changes: 4 additions & 0 deletions docs/xx-appendices/recommended-reading/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ This section is being expanded regularly, so check back often to find more recom

Some great books and articles for specific topics are listed below.

TODO TODO TODO

There are numerous articles and online books on Git - I also recommend the excellent book "Pro Git" by Scott Chacon and Ben Straub.

## Fantastic Books

Each of these books would make a great addition to your bookshelf if you are a technologist. Many of these books I have read multiple times and still go back to as a reference.
Expand Down
Loading

0 comments on commit 08bf4d6

Please sign in to comment.