IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixup docfield example usage.

Browse Source
This commit is contained in:
Georg Brandl 2013-09-16 03:51:02 +02:00
parent 8faf315643
commit d521ebf93e
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/domains.rst
View File

@ -320,9 +320,9 @@ explained by an example::
Send a message to a recipient Send a message to a recipient
:param string sender: The person sending the message :param str sender: The person sending the message
:param string recipient: The recipient of the message :param str recipient: The recipient of the message
:param string message_body: The body of the message :param str message_body: The body of the message
:param priority: The priority of the message, can be a number 1-5 :param priority: The priority of the message, can be a number 1-5
:type priority: integer or None :type priority: integer or None
:return: the message id :return: the message id
@ -337,11 +337,10 @@ This will render like this:
Send a message to a recipient Send a message to a recipient
:param sender: The person sending the message :param str sender: The person sending the message
:type sender: string :param str recipient: The recipient of the message
:param recipient: The recipient of the message :param str message_body: The body of the message
:param message_body: The body of the message :param priority: The priority of the message, can be a number 1-5
:param priority: The priority of the message (defaults to highest)
:type priority: integer or None :type priority: integer or None
:return: the message id :return: the message id
:rtype: int :rtype: int
@ -351,7 +350,7 @@ This will render like this:
It is also possible to combine parameter type and description, if the type is a It is also possible to combine parameter type and description, if the type is a
single word, like this:: single word, like this::
:param integer priority: The priority of the message, can be a number 1-5 :param int priority: The priority of the message, can be a number 1-5
.. _python-roles: .. _python-roles: