Skip to content

Commit eda25f8

Browse files
Small docs improvement for using CLI (#372)
* Updated the formatting of the text to improve the documentation.
1 parent 0ad0571 commit eda25f8

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/using-cli.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If your command corresponds to a list or tuple, you can extend your command by
5757
adding the index of an element of the component to your command as an argument.
5858

5959
For example, `widget function-that-returns-list 2` will correspond to item 2 of
60-
the result of function_that_returns_list.
60+
the result of `function_that_returns_list`.
6161

6262

6363
### Calling a function
@@ -90,7 +90,7 @@ See also the section on [Changing the Separator](#separator-flag).
9090
### Instantiating a class
9191

9292
If your command corresponds to a class, you can extend your command by adding
93-
the arguments of the class's \_\_init\_\_ function. Arguments must be specified
93+
the arguments of the class's `__init__` function. Arguments must be specified
9494
by name, using the flags syntax. See the section on
9595
[calling a function](#calling-a-function) for more details.
9696

@@ -105,8 +105,8 @@ after the final standalone `--` argument. (If there is no `--` argument, then no
105105
arguments are used for flags.)
106106

107107
For example, to set the alsologtostderr flag, you could run the command:
108-
`widget bang --noise=boom -- --alsologtostderr`. The --noise argument is
109-
consumed by Fire, but the --alsologtostderr argument is treated as a normal
108+
`widget bang --noise=boom -- --alsologtostderr`. The `--noise` argument is
109+
consumed by Fire, but the `--alsologtostderr` argument is treated as a normal
110110
Flag.
111111

112112
All CLIs built with Python Fire share some flags, as described in the next
@@ -146,7 +146,7 @@ the `ipython` package needs to be installed in your environment.
146146
Call `widget -- --completion` to generate a completion script for the Fire CLI
147147
`widget`. To save the completion script to your home directory, you could e.g.
148148
run `widget -- --completion > ~/.widget-completion`. You should then source this
149-
file; to get permanent completion, source this file from your .bashrc file.
149+
file; to get permanent completion, source this file from your `.bashrc` file.
150150

151151
Call `widget -- --completion fish` to generate a completion script for the Fish
152152
shell. Source this file from your fish.config.
@@ -177,7 +177,7 @@ corresponds to, as well as usage information for how to extend that command.
177177
### `--trace`: Getting a Fire trace <a name="trace-flag"></a>
178178

179179
In order to understand what is happening when you call Python Fire, it can be
180-
useful to request a trace. This is done via the --trace flag, e.g.
180+
useful to request a trace. This is done via the `--trace` flag, e.g.
181181
`widget whack 5 -- --trace`.
182182

183183
A trace provides step by step information about how the Fire command was

0 commit comments

Comments
 (0)