Skip to content

Commit 9622d4e

Browse files
committed
Improve usage of :: in README.rst
1 parent 0a1f4cf commit 9622d4e

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.rst

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,33 @@ Usage
3434

3535
For more in depth info please check usage with ``codespell -h``.
3636

37-
Some noteworthy flags::
37+
Some noteworthy flags:
38+
39+
::
3840

3941
codespell -w, --write-changes
4042

41-
The ``-w`` flag will actually implement the changes recommended by codespell. Not running with ``-w`` flag is the same as with doing a dry run. It is recommended to run this with the ``-i`` or ``--interactive`` flag.::
43+
The ``-w`` flag will actually implement the changes recommended by codespell. Not running with ``-w`` flag is the same as with doing a dry run. It is recommended to run this with the ``-i`` or ``--interactive`` flag.
44+
45+
::
4246

4347
codespell -I FILE, --ignore-words=FILE
4448

45-
The ``-I`` flag can be used for a list of certain words to allow that are in the codespell dictionaries. The format of the file is one word per line. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell referencing said list of allowed words. **Important note:** The list passed to ``-I`` is case-sensitive based on how it is listed in the codespell dictionaries.::
49+
The ``-I`` flag can be used for a list of certain words to allow that are in the codespell dictionaries. The format of the file is one word per line. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell referencing said list of allowed words. **Important note:** The list passed to ``-I`` is case-sensitive based on how it is listed in the codespell dictionaries.
50+
51+
::
4652

4753
codespell -L word1,word2,word3,word4
4854

49-
The ``-L`` flag can be used to allow certain words that are comma-separated placed immediately after it. **Important note:** The list passed to ``-L`` is case-sensitive based on how it is listed in the codespell dictionaries.::
55+
The ``-L`` flag can be used to allow certain words that are comma-separated placed immediately after it. **Important note:** The list passed to ``-L`` is case-sensitive based on how it is listed in the codespell dictionaries.
56+
57+
::
5058

5159
codespell -x FILE, --exclude-file=FILE
5260

53-
Ignore whole lines that match those in ``FILE``. The lines in ``FILE`` should match the to-be-excluded lines exactly.::
61+
Ignore whole lines that match those in ``FILE``. The lines in ``FILE`` should match the to-be-excluded lines exactly.
62+
63+
::
5464

5565
codespell -S, --skip=
5666

@@ -61,12 +71,16 @@ Comma-separated list of files to skip. It accepts globs as well. Examples:
6171
* to skip directories, invoke ``codespell --skip="./src/3rd-Party,./src/Test"``
6272

6373

64-
Useful commands::
74+
Useful commands:
75+
76+
::
6577

6678
codespell -d -q 3 --skip="*.po,*.ts,./src/3rdParty,./src/Test"
6779

6880
List all typos found except translation files and some directories.
69-
Display them without terminal colors and with a quiet level of 3.::
81+
Display them without terminal colors and with a quiet level of 3.
82+
83+
::
7084

7185
codespell -i 3 -w
7286

0 commit comments

Comments
 (0)