Skip to content

Commit

Permalink
(DOCSP-11407): Update Parameters page
Browse files Browse the repository at this point in the history
  • Loading branch information
melissamahoney-mongodb committed Jul 23, 2020
1 parent e664066 commit e8b9427
Showing 1 changed file with 1 addition and 15 deletions.
16 changes: 1 addition & 15 deletions source/style-guide/style/parameters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
Parameters
==========

.. include:: /style-guide/includes/page-needs-update.rst

When documenting parameters, use the following guidelines:

- In request and response examples, show all of the parameters.
Expand All @@ -20,25 +18,13 @@ When documenting parameters, use the following guidelines:

- Write the first sentence of a description with an implied
subject. For example, if the parameter is ``name``, the
description might be "Server name, which becomes the initial host
name of the server."
description might be "Initial host name of the server."

- Include any valid values and default value at the end of the
description. Use the formats "Valid values are *n* and *n*." and
"The default is *n*." For example, "Valid values are ``true`` and
``false``." and "The default is ``false``."

- For request body parameters only, label the required parameters by
adding the *(Required)* qualifier to the beginning of the
description. For example:

*(Required)* Path of the parameter to update. Valid values are
``/enabled``, ``/vault/region``, ``/vault/use_internal``, and
``/log-level``.

Don't label optional request body parameters. Also, don't label URI,
query, or response body parameters as either optional or required.

- When listing and describing request and response body parameters in
tables, show the parameters in the same order as they're shown in
the examples. If you have more than one example, match the order in
Expand Down

0 comments on commit e8b9427

Please sign in to comment.