Skip to content

Commit d8513ab

Browse files
committed
some docs update
1 parent ecc15d2 commit d8513ab

File tree

3 files changed

+48
-10
lines changed

3 files changed

+48
-10
lines changed

docs/commandline.rst

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@ The commands are:
2020
deep diff command
2121
-----------------
2222

23-
Run `$ deep diff --help` to get the options:
23+
Run
24+
25+
.. code:: bash
26+
27+
$ deep diff
28+
29+
to get the options:
2430

2531
.. code-block:: bash
2632
@@ -101,15 +107,21 @@ what if we assume last names are unique and group by last_name?
101107
The path is perhaps more readable now: `root['Molotov']['zip']`. It is more clear that the zip code of Molotov has changed.
102108
103109
.. Note::
104-
The parameters in the deep diff commandline are a subset of those in :ref:`deepdiff_label` 's Python API.
110+
The parameters in the deep diff commandline are a subset of those in :ref:`deepdiff_module_label` 's Python API.
105111
106112
107113
.. _deep_grep_command:
108114
109115
deep grep command
110116
-----------------
111117
112-
Run `$ deep grep --help` to get the options:
118+
Run
119+
120+
.. code:: bash
121+
122+
$ deep grep
123+
124+
to get the options:
113125
114126
.. code-block:: bash
115127
@@ -145,7 +157,13 @@ Run `$ deep grep --help` to get the options:
145157
deep extract command
146158
--------------------
147159
148-
Run `$ deep extract --help` to get the options:
160+
Run
161+
162+
.. code:: bash
163+
164+
$ deep extract
165+
166+
to get the options:
149167
150168
.. code-block:: bash
151169
@@ -175,7 +193,13 @@ Run `$ deep extract --help` to get the options:
175193
deep patch command
176194
------------------
177195
178-
Run `$ deep patch --help` to get the options:
196+
Run
197+
198+
.. code:: bash
199+
200+
$ deep patch --help
201+
202+
to get the options:
179203
180204
.. code-block:: bash
181205

docs/diff_doc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _deepdiff_label:
1+
.. _deepdiff_module_label:
22

33
DeepDiff
44
========

docs/index.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,27 @@ Note: if you want to use DeepDiff via commandline, make sure to run::
7373

7474
Then you can access the commands via:
7575

76-
- DeepDiff::
76+
- DeepDiff
77+
78+
.. code:: bash
79+
7780
$ deep diff --help
78-
- Delta::
81+
82+
- Delta
83+
84+
.. code:: bash
85+
7986
$ deep patch --help
80-
- grep::
87+
88+
- grep
89+
90+
.. code:: bash
91+
8192
$ deep grep --help
82-
- extract::
93+
- extract
94+
95+
.. code:: bash
96+
8397
$ deep extract --help
8498
8599
Supported data types

0 commit comments

Comments
 (0)