diff options
author | Aaron Carlisle <Blendify> | 2020-10-23 00:20:57 +0300 |
---|---|---|
committer | Aaron Carlisle <carlisle.b3d@gmail.com> | 2020-10-23 00:22:05 +0300 |
commit | baa24f1c91d21e10f51881f8fad012f30f99e26f (patch) | |
tree | e3872d6dd8d50ddb657d9610a2ce3b7a6a31bef9 /source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp | |
parent | 956af161893f70198bd89d5ab338a24a011d30c2 (diff) |
Pydoc: Fix sphinx compile warnings about freestyle
Sphinx expects functions and methods with the same name and different
parameters to be written using one directive. See:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#basic-markup
Unfortunately this makes giving different descriptions for each harder.
This was already a request for better support for this in sphinx, see:
https://github.com/sphinx-doc/sphinx/issues/7787
Reviewed By: campbellbarton
Differential Revision: https://developer.blender.org/D9170
Diffstat (limited to 'source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp')
-rw-r--r-- | source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp | 13 |
1 files changed, 3 insertions, 10 deletions
diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp index 187ab94360a..e04a89bad3b 100644 --- a/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp +++ b/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp @@ -48,20 +48,13 @@ PyDoc_STRVAR(FEdge_doc, "from one to the other.\n" "\n" ".. method:: FEdge()\n" + " FEdge(brother)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: FEdge(brother)\n" - "\n" - " Copy constructor.\n" + " Builds an :class:`FEdge` using the default constructor,\n" + " copy constructor, or between two :class:`SVertex` objects.\n" "\n" " :arg brother: An FEdge object.\n" " :type brother: :class:`FEdge`\n" - "\n" - ".. method:: FEdge(first_vertex, second_vertex)\n" - "\n" - " Builds an FEdge going from the first vertex to the second.\n" - "\n" " :arg first_vertex: The first SVertex.\n" " :type first_vertex: :class:`SVertex`\n" " :arg second_vertex: The second SVertex.\n" |