Skip to content

Commit

Permalink
Fix raw command Sphinx doc by using backticks
Browse files Browse the repository at this point in the history
to ensure monospace font.
  • Loading branch information
JOJ0 committed Oct 13, 2023
1 parent 27de041 commit c255690
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions synadm/cli/raw.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ def raw_request_cmd(helper, endpoint, method, data, data_file):
""" Issue a custom request to the Synapse Admin API.
The endpoint argument is the part of the URL _after_ the configured
"Synapse base URL" and "Synapse Admin API path" (see `synadm config`).
"Synapse base URL" and "Synapse Admin API path" (see ``synadm config``).
A get request to the "Query User Account API" would look like this:
`synadm raw v2/users/%40testuser%3Aexample.org`. URL encoding must be
``synadm raw v2/users/%40testuser%3Aexample.org``. URL encoding must be
handled at this point. Consider enabling debug outputs via synadm's global
flag `-vv`
flag ``-vv``
"""
if data_file:
data = data_file.read()
Expand Down

0 comments on commit c255690

Please sign in to comment.