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/Iterator/BPy_SVertexIterator.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/Iterator/BPy_SVertexIterator.cpp')
-rw-r--r-- | source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp | 60 |
1 files changed, 27 insertions, 33 deletions
diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp index 4a5927ff6eb..83c504081c1 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp @@ -32,39 +32,33 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- -PyDoc_STRVAR(SVertexIterator_doc, - "Class hierarchy: :class:`Iterator` > :class:`SVertexIterator`\n" - "\n" - "Class representing an iterator over :class:`SVertex` of a\n" - ":class:`ViewEdge`. An instance of an SVertexIterator can be obtained\n" - "from a ViewEdge by calling verticesBegin() or verticesEnd().\n" - "\n" - ".. method:: __init__()\n" - "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: An SVertexIterator object.\n" - " :type brother: :class:`SVertexIterator`\n" - "\n" - ".. method:: __init__(vertex, begin, previous_edge, next_edge, t)\n" - "\n" - " Build an SVertexIterator that starts iteration from an SVertex\n" - " object v.\n" - "\n" - " :arg vertex: The SVertex from which the iterator starts iteration.\n" - " :type vertex: :class:`SVertex`\n" - " :arg begin: The first SVertex of a ViewEdge.\n" - " :type begin: :class:`SVertex`\n" - " :arg previous_edge: The previous FEdge coming to vertex.\n" - " :type previous_edge: :class:`FEdge`\n" - " :arg next_edge: The next FEdge going out from vertex.\n" - " :type next_edge: :class:`FEdge`\n" - " :arg t: The curvilinear abscissa at vertex.\n" - " :type t: float"); +PyDoc_STRVAR( + SVertexIterator_doc, + "Class hierarchy: :class:`Iterator` > :class:`SVertexIterator`\n" + "\n" + "Class representing an iterator over :class:`SVertex` of a\n" + ":class:`ViewEdge`. An instance of an SVertexIterator can be obtained\n" + "from a ViewEdge by calling verticesBegin() or verticesEnd().\n" + "\n" + ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(vertex, begin, previous_edge, next_edge, t)" + "\n" + " Build an SVertexIterator using either the default constructor, copy constructor,\n" + " or the overloaded constructor that starts iteration from an SVertex object vertex.\n" + "\n" + " :arg brother: An SVertexIterator object.\n" + " :type brother: :class:`SVertexIterator`\n" + " :arg vertex: The SVertex from which the iterator starts iteration.\n" + " :type vertex: :class:`SVertex`\n" + " :arg begin: The first SVertex of a ViewEdge.\n" + " :type begin: :class:`SVertex`\n" + " :arg previous_edge: The previous FEdge coming to vertex.\n" + " :type previous_edge: :class:`FEdge`\n" + " :arg next_edge: The next FEdge going out from vertex.\n" + " :type next_edge: :class:`FEdge`\n" + " :arg t: The curvilinear abscissa at vertex.\n" + " :type t: float"); static int SVertexIterator_init(BPy_SVertexIterator *self, PyObject *args, PyObject *kwds) { |