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/BPy_StrokeAttribute.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/BPy_StrokeAttribute.cpp')
-rw-r--r-- | source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp | 24 |
1 files changed, 7 insertions, 17 deletions
diff --git a/source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp b/source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp index 214385f74ad..3718fddcf20 100644 --- a/source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp +++ b/source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp @@ -53,20 +53,16 @@ PyDoc_STRVAR(StrokeAttribute_doc, "Vertex.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(red, green, blue, alpha, thickness_right, thickness_left)\n" + " __init__(attribute1, attribute2, t)\n" "\n" - " Default constructor.\n" + " Creates a :class:`StrokeAttribute` object using either a default constructor,\n" + " copy constructor, overloaded constructor, or and interpolation constructor\n" + " to interpolate between two :class:`StrokeAttribute` objects.\n" "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: A StrokeAttribute object.\n" + " :arg brother: A StrokeAttribute object to be used as a copy constructor.\n" " :type brother: :class:`StrokeAttribute`\n" - "\n" - ".. method:: __init__(red, green, blue, alpha, thickness_right, thickness_left)\n" - "\n" - " Build a stroke vertex attribute from a set of parameters.\n" - "\n" " :arg red: Red component of a stroke color.\n" " :type red: float\n" " :arg green: Green component of a stroke color.\n" @@ -79,12 +75,6 @@ PyDoc_STRVAR(StrokeAttribute_doc, " :type thickness_right: float\n" " :arg thickness_left: Stroke thickness on the left.\n" " :type thickness_left: float\n" - "\n" - ".. method:: __init__(attribute1, attribute2, t)\n" - "\n" - " Interpolation constructor. Build a StrokeAttribute from two\n" - " StrokeAttribute objects and an interpolation parameter.\n" - "\n" " :arg attribute1: The first StrokeAttribute object.\n" " :type attribute1: :class:`StrokeAttribute`\n" " :arg attribute2: The second StrokeAttribute object.\n" |