From baa24f1c91d21e10f51881f8fad012f30f99e26f Mon Sep 17 00:00:00 2001 From: Aaron Carlisle Date: Thu, 22 Oct 2020 17:20:57 -0400 Subject: 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 --- .../intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp | 9 +++------ .../python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp | 9 +++------ .../intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp | 9 +++------ .../python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp | 9 +++------ .../intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp | 9 +++------ .../intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp | 9 +++------ .../UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp | 9 +++------ .../intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp | 9 +++------ 8 files changed, 24 insertions(+), 48 deletions(-) (limited to 'source/blender/freestyle/intern/python/UnaryFunction1D') diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp index 88705c41204..b59e27dcea9 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp @@ -160,13 +160,10 @@ static char UnaryFunction1DDouble___doc__[] = ":class:`Interface1D` and return a float value.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp index 3cfc5464296..2f5a59f9c7a 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp @@ -65,13 +65,10 @@ static char UnaryFunction1DEdgeNature___doc__[] = ":class:`Interface1D` and return a :class:`Nature` object.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp index 4fdc68a2e89..e11d21b6c8e 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp @@ -56,13 +56,10 @@ static char UnaryFunction1DFloat___doc__[] = ":class:`Interface1D` and return a float value.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp index 218afa3ff10..e04a5b9d7f4 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp @@ -65,13 +65,10 @@ static char UnaryFunction1DUnsigned___doc__[] = ":class:`Interface1D` and return an int value.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp index 939ccfb8905..f8d75640811 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp @@ -71,13 +71,10 @@ static char UnaryFunction1DVec2f___doc__[] = ":class:`Interface1D` and return a 2D vector.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp index 02b6373cce4..9f71fb3840b 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp @@ -64,13 +64,10 @@ static char UnaryFunction1DVec3f___doc__[] = ":class:`Interface1D` and return a 3D vector.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp index b2020e9f554..cb4982f4532 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp @@ -80,13 +80,10 @@ static char UnaryFunction1DVectorViewShape___doc__[] = "objects.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp index 7b25daa24f9..46564cdaeca 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp @@ -79,13 +79,10 @@ static char UnaryFunction1DVoid___doc__[] = ":class:`Interface1D`.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using either a default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; -- cgit v1.2.3