Skip to content

Commit 5a74c87

Browse files
committed
doc: use code-blocks in the docstrings
1 parent d1e4f66 commit 5a74c87

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

scim_cli/__init__.py

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ def cli(ctx, url):
2929
def get(ctx):
3030
"""Perform a SCIM GET request.
3131
32-
Data passed in JSON format to stdin is sent as request arguments::
32+
Data passed in JSON format to stdin is sent as request arguments:
33+
34+
.. code-block:: bash
3335
3436
echo '{"foo": "bar"}' | scim https://scim.example get
3537
@@ -50,7 +52,9 @@ def get(ctx):
5052
def post(ctx):
5153
"""Perform a SCIM POST request.
5254
53-
Data passed in JSON format to stdin is sent as request payload::
55+
Data passed in JSON format to stdin is sent as request payload:
56+
57+
.. code-block:: bash
5458
5559
echo '{"foo": "bar"}' | scim https://scim.example post
5660
@@ -71,7 +75,9 @@ def post(ctx):
7175
def put(ctx):
7276
"""Perform a SCIM PUT request.
7377
74-
Data passed in JSON format to stdin is sent as request payload::
78+
Data passed in JSON format to stdin is sent as request payload:
79+
80+
.. code-block:: bash
7581
7682
echo '{"foo": "bar"}' | scim https://scim.example put
7783
@@ -92,7 +98,9 @@ def put(ctx):
9298
def patch(ctx):
9399
"""Perform a SCIM PATCH request.
94100
95-
Data passed in JSON format to stdin is sent as request payload::
101+
Data passed in JSON format to stdin is sent as request payload:
102+
103+
.. code-block:: bash
96104
97105
echo '{"foo": "bar"}' | scim https://scim.example patch
98106
@@ -113,7 +121,9 @@ def patch(ctx):
113121
def delete(ctx):
114122
"""Perform a SCIM DELETE request.
115123
116-
Data passed in JSON format to stdin is sent as request payload::
124+
Data passed in JSON format to stdin is sent as request payload:
125+
126+
.. code-block:: bash
117127
118128
echo '{"foo": "bar"}' | scim https://scim.example delete
119129

0 commit comments

Comments
 (0)