Skip to content

Commit c1fafd6

Browse files
Merge pull request #1962 from jaymessina3:master
PiperOrigin-RevId: 421042378
2 parents 9adea2a + 5c03568 commit c1fafd6

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

tools/tensorflow_docs/tools/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ maintainable documentation.
1717
Use `pip` to install the latest `tensorflow-docs` package directly from the
1818
[tensorflow/docs](https://github.com/tensorflow/docs) GitHub repository:
1919

20-
```
20+
```shell
2121
$ python3 -m pip install -U --user git+https://github.com/tensorflow/docs
2222
```
2323

@@ -31,7 +31,7 @@ uses opinionated defaults with a preference for the TensorFlow docs Colab
3131
workflow. To format a notebook, install the `tensorflow-docs` package and run
3232
the `nbfmt` tool:
3333

34-
```
34+
```shell
3535
$ python3 -m tensorflow_docs.tools.nbfmt [options] notebook.ipynb [...]
3636

3737
$ python3 -m tensorflow_docs.tools.nbfmt --help
@@ -70,12 +70,12 @@ repos:
7070

7171
Someone who clones that repo for development would then install the hook with:
7272

73-
```
73+
```shell
7474
# Install pre-commit framework
75-
pip3 install pre-commit
75+
$ pip3 install pre-commit
7676

7777
# Install hooks
78-
pre-commit install
78+
$ pre-commit install
7979
```
8080

8181
## nblint
@@ -84,7 +84,7 @@ A notebook linting tool that checks documentation style rules. Used to catch
8484
common errors and useful for CI tests. To lint a notebook, install the
8585
`tensorflow-docs` package and run the `nblint` tool:
8686

87-
```
87+
```shell
8888
$ python3 -m tensorflow_docs.tools.nblint [options] notebook.ipynb [...]
8989

9090
$ python3 -m tensorflow_docs.tools.nblint --fix [options] notebook.ipynb [...]
@@ -95,7 +95,7 @@ $ python3 -m tensorflow_docs.tools.nblint --help
9595
Some styles require a user-defined argument passed at the command-line. For
9696
example, the `tensorflow` style (default) uses the `repo` argument to check links:
9797

98-
```
98+
```shell
9999
$ python3 -m tensorflow_docs.tools.nblint --arg=repo:tensorflow/docs notebook.ipynb
100100
```
101101

@@ -105,7 +105,7 @@ are collected into
105105
`nblint` tests the `google` and `tensorflow` styles by default, and different
106106
styles can be set with the `--styles` option:
107107

108-
```
108+
```shell
109109
$ python3 -m tensorflow_docs.tools.nblint \
110110
--styles=tensorflow,tensorflow_docs_l10n --arg=repo:tensorflow/docs-1l0n \
111111
notebook.ipynb
@@ -114,7 +114,7 @@ $ python3 -m tensorflow_docs.tools.nblint \
114114
A style module may contain some lint checks that do not fit your project. You
115115
can exclude specific lint checks with the `--exclude_lint` option:
116116

117-
```
117+
```shell
118118
$ python3 -m tensorflow_docs.tools.nblint \
119119
--styles=tensorflow --arg=repo:community/repo-name \
120120
--exclude_lint=tensorflow::copyright_check \
@@ -124,7 +124,7 @@ $ python3 -m tensorflow_docs.tools.nblint \
124124

125125
Some lint errors can be automatically fixed in the notebook file:
126126

127-
```
127+
```shell
128128
$ python3 -m tensorflow_docs.tools.nblint --fix \
129129
--arg=repo:tensorflow/docs notebook.ipynb
130130
```

0 commit comments

Comments
 (0)