Skip to content

Commit

Permalink
Merge pull request ceph#30847 from rhcs-dashboard/fix-42268-master
Browse files Browse the repository at this point in the history
mgr/dashboard: fix typos in HACKING.rst

Reviewed-by: Ricardo Marques <[email protected]>
  • Loading branch information
rjfd authored Oct 11, 2019
2 parents 44a32df + 0ab9fbd commit d45f2da
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/pybind/mgr/dashboard/HACKING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -836,7 +836,7 @@ parameter.
For ``POST`` and ``PUT`` methods, all method parameters are considered
body parameters by default. To override this default, one can use the
``path_params`` and ``query_params`` to specify which method parameters are
path and query parameters respectivelly.
path and query parameters respectively.
Body parameters are decoded from the request body, either from a form format, or
from a dictionary in JSON format.
Expand Down Expand Up @@ -1667,9 +1667,11 @@ API endpoints.However, by default it is not very detailed. There are two
decorators that can be used to add more information:
* ``@EndpointDoc()`` for documentation of endpoints. It has four optional arguments
(explained below): ``description``, ``group``, ``parameters`` and``responses``.
(explained below): ``description``, ``group``, ``parameters`` and
``responses``.
* ``@ControllerDoc()`` for documentation of controller or group associated with
the endpoints. It only takes the two first arguments: ``description`` and``group``.
the endpoints. It only takes the two first arguments: ``description`` and
``group``.
``description``: A a string with a short (1-2 sentences) description of the object.
Expand Down

0 comments on commit d45f2da

Please sign in to comment.