From 60682885c03a1b7265004898ef32dc378c1985eb Mon Sep 17 00:00:00 2001 From: Denis Rouzaud Date: Tue, 26 Mar 2019 14:00:37 -0500 Subject: [PATCH] Small tweak to enum Python docs (#9631) original credits to @nyalldawson --- python/core/auto_additions/qgsmaplayer.py | 2 +- python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py | 2 +- scripts/sipify.pl | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/python/core/auto_additions/qgsmaplayer.py b/python/core/auto_additions/qgsmaplayer.py index e4baf5bdda2..4535f58d3d3 100644 --- a/python/core/auto_additions/qgsmaplayer.py +++ b/python/core/auto_additions/qgsmaplayer.py @@ -9,7 +9,7 @@ QgsMapLayer.PluginLayer = QgsMapLayerType.PluginLayer QgsMapLayer.PluginLayer.__doc__ = "" QgsMapLayer.MeshLayer = QgsMapLayerType.MeshLayer QgsMapLayer.MeshLayer.__doc__ = "Added in 3.2" -QgsMapLayerType.__doc__ = 'Types of layers that can be added to a map\n\n.. versionadded:: 3.8\n\n' + '* VectorLayer: ' + QgsMapLayerType.VectorLayer.__doc__ + '\n' + '* RasterLayer: ' + QgsMapLayerType.RasterLayer.__doc__ + '\n' + '* PluginLayer: ' + QgsMapLayerType.PluginLayer.__doc__ + '\n' + '* MeshLayer: ' + QgsMapLayerType.MeshLayer.__doc__ +QgsMapLayerType.__doc__ = 'Types of layers that can be added to a map\n\n.. versionadded:: 3.8\n\n' + '* ``VectorLayer``: ' + QgsMapLayerType.VectorLayer.__doc__ + '\n' + '* ``RasterLayer``: ' + QgsMapLayerType.RasterLayer.__doc__ + '\n' + '* ``PluginLayer``: ' + QgsMapLayerType.PluginLayer.__doc__ + '\n' + '* ``MeshLayer``: ' + QgsMapLayerType.MeshLayer.__doc__ # -- QgsMapLayer.LayerFlag.baseClass = QgsMapLayer QgsMapLayer.LayerFlags.baseClass = QgsMapLayer diff --git a/python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py b/python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py index 42f32edb31e..2c4ed202a7f 100644 --- a/python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py +++ b/python/gui/auto_additions/qgsadvanceddigitizingdockwidget.py @@ -8,5 +8,5 @@ QgsAdvancedDigitizingDockWidget.Perpendicular = QgsAdvancedDigitizingDockWidget. QgsAdvancedDigitizingDockWidget.AdditionalConstraint.Perpendicular.__doc__ = "Perpendicular" QgsAdvancedDigitizingDockWidget.Parallel = QgsAdvancedDigitizingDockWidget.AdditionalConstraint.Parallel QgsAdvancedDigitizingDockWidget.AdditionalConstraint.Parallel.__doc__ = "Parallel" -QgsAdvancedDigitizingDockWidget.AdditionalConstraint.__doc__ = 'Additional constraints which can be enabled\n\n' + '* NoConstraint: ' + QgsAdvancedDigitizingDockWidget.AdditionalConstraint.NoConstraint.__doc__ + '\n' + '* Perpendicular: ' + QgsAdvancedDigitizingDockWidget.AdditionalConstraint.Perpendicular.__doc__ + '\n' + '* Parallel: ' + QgsAdvancedDigitizingDockWidget.AdditionalConstraint.Parallel.__doc__ +QgsAdvancedDigitizingDockWidget.AdditionalConstraint.__doc__ = 'Additional constraints which can be enabled\n\n' + '* ``NoConstraint``: ' + QgsAdvancedDigitizingDockWidget.AdditionalConstraint.NoConstraint.__doc__ + '\n' + '* ``Perpendicular``: ' + QgsAdvancedDigitizingDockWidget.AdditionalConstraint.Perpendicular.__doc__ + '\n' + '* ``Parallel``: ' + QgsAdvancedDigitizingDockWidget.AdditionalConstraint.Parallel.__doc__ # -- diff --git a/scripts/sipify.pl b/scripts/sipify.pl index 41d8552a1b6..ff3a71ec6a8 100755 --- a/scripts/sipify.pl +++ b/scripts/sipify.pl @@ -995,11 +995,11 @@ while ($LINE_IDX < $LINE_COUNT){ if ($enum_mk_base ne "") { push @OUTPUT_PYTHON, "$enum_mk_base.$enum_member = $enum_qualname.$enum_member\n"; push @OUTPUT_PYTHON, "$enum_mk_base.$enum_member.__doc__ = \"$comment\"\n" ; - push @enum_members_doc, "'* $enum_member: ' + $enum_qualname.$enum_member.__doc__"; + push @enum_members_doc, "'* ``$enum_member``: ' + $enum_qualname.$enum_member.__doc__"; } else { push @OUTPUT_PYTHON, "$ACTUAL_CLASS.$enum_member = $ACTUAL_CLASS.$enum_qualname.$enum_member\n"; push @OUTPUT_PYTHON, "$ACTUAL_CLASS.$enum_qualname.$enum_member.__doc__ = \"$comment\"\n"; - push @enum_members_doc, "'* $enum_member: ' + $ACTUAL_CLASS.$enum_qualname.$enum_member.__doc__"; + push @enum_members_doc, "'* ``$enum_member``: ' + $ACTUAL_CLASS.$enum_qualname.$enum_member.__doc__"; } } }