Skip to content

Commit acfb552

Browse files
committed
doc: use Sphinx links in CLI docstrings
1 parent 5a74c87 commit acfb552

1 file changed

Lines changed: 5 additions & 15 deletions

File tree

scim_cli/__init__.py

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,13 @@ def cli(ctx, url):
2727
@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
2828
@click.pass_context
2929
def get(ctx):
30-
"""Perform a SCIM GET request.
30+
"""Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request.
3131
3232
Data passed in JSON format to stdin is sent as request arguments:
3333
3434
.. code-block:: bash
3535
3636
echo '{"foo": "bar"}' | scim https://scim.example get
37-
38-
Details on: https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1
3937
"""
4038

4139
response = requests.get(
@@ -50,15 +48,13 @@ def get(ctx):
5048
@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
5149
@click.pass_context
5250
def post(ctx):
53-
"""Perform a SCIM POST request.
51+
"""Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request.
5452
5553
Data passed in JSON format to stdin is sent as request payload:
5654
5755
.. code-block:: bash
5856
5957
echo '{"foo": "bar"}' | scim https://scim.example post
60-
61-
https://www.rfc-editor.org/rfc/rfc7644#section-3.3
6258
"""
6359

6460
response = requests.post(
@@ -73,15 +69,13 @@ def post(ctx):
7369
@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
7470
@click.pass_context
7571
def put(ctx):
76-
"""Perform a SCIM PUT request.
72+
"""Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1>`_ request.
7773
7874
Data passed in JSON format to stdin is sent as request payload:
7975
8076
.. code-block:: bash
8177
8278
echo '{"foo": "bar"}' | scim https://scim.example put
83-
84-
https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1
8579
"""
8680

8781
response = requests.put(
@@ -96,15 +90,13 @@ def put(ctx):
9690
@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
9791
@click.pass_context
9892
def patch(ctx):
99-
"""Perform a SCIM PATCH request.
93+
"""Perform a `SCIM PATCH <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.2>`_ request.
10094
10195
Data passed in JSON format to stdin is sent as request payload:
10296
10397
.. code-block:: bash
10498
10599
echo '{"foo": "bar"}' | scim https://scim.example patch
106-
107-
https://www.rfc-editor.org/rfc/rfc7644#section-3.5.2
108100
"""
109101

110102
response = requests.patch(
@@ -119,15 +111,13 @@ def patch(ctx):
119111
@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
120112
@click.pass_context
121113
def delete(ctx):
122-
"""Perform a SCIM DELETE request.
114+
"""Perform a `SCIM DELETE <https://www.rfc-editor.org/rfc/rfc7644#section-3.6>`_ request.
123115
124116
Data passed in JSON format to stdin is sent as request payload:
125117
126118
.. code-block:: bash
127119
128120
echo '{"foo": "bar"}' | scim https://scim.example delete
129-
130-
https://www.rfc-editor.org/rfc/rfc7644#section-3.6
131121
"""
132122

133123
response = requests.delete(

0 commit comments

Comments
 (0)