From 175cfca495837a0a19f23261f462852128e7f4a8 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 13 May 2026 04:18:38 -0700 Subject: [PATCH 1/3] Fix malformed docstring for rolemap.importRolemap The docstring was malformed and invalid, resulting in Sphinx build errors in the main Plone documentation. ``` Plone/documentation/venv/lib/python3.13/site-packages/Products/GenericSetup/rolemap.py:docstring of Products.GenericSetup.rolemap.importRolemap:9: ERROR: Unexpected indentation. [docutils] Plone/documentation/venv/lib/python3.13/site-packages/Products/GenericSetup/rolemap.py:docstring of Products.GenericSetup.rolemap.importRolemap:19: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils] This PR fixes the docstrings, adding proper lexers. Now it looks purty. See screenshot. --- src/Products/GenericSetup/rolemap.py | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/src/Products/GenericSetup/rolemap.py b/src/Products/GenericSetup/rolemap.py index 595420d..5c6f460 100644 --- a/src/Products/GenericSetup/rolemap.py +++ b/src/Products/GenericSetup/rolemap.py @@ -34,25 +34,28 @@ def importRolemap(context): - """ Import roles / permission map from an XML file. + """Import roles / permission map from an XML file. - o 'context' must implement IImportContext. + - 'context' must implement ``IImportContext``. + - Register via Python. - o Register via Python: + .. code-block:: python - registry = site.setup_tool.setup_steps - registry.registerStep('importRolemap', '20040518-01', - Products.GenericSetup.rolemap.importRolemap, - (), 'Role / Permission import', - 'Import roles and map roles to permissions') + registry = site.setup_tool.setup_steps + registry.registerStep('importRolemap', '20040518-01', + Products.GenericSetup.rolemap.importRolemap, + (), 'Role / Permission import', + 'Import roles and map roles to permissions') - o Register via XML: + - Register via XML. + + .. code-block:: xml - Import additional roles, and map roles to permissions. + >Import additional roles, and map roles to permissions. """ site = context.getSite() From 3431c2874fd7c6ebddfde1bae565f9c2a2bd9ab1 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 13 May 2026 04:23:12 -0700 Subject: [PATCH 2/3] Add change log --- CHANGES.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index 077c315..57e000b 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -6,6 +6,8 @@ Changelog - Move package metadata from setup.py to pyproject.toml. +- Fix malformed docstring in ``rolemap.importRolemap``. + 5.1.0 (2025-11-19) ------------------ From 86459d74b97a5c37616d53580f051e812344c7d9 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 13 May 2026 04:28:21 -0700 Subject: [PATCH 3/3] Fix lint --- src/Products/GenericSetup/rolemap.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Products/GenericSetup/rolemap.py b/src/Products/GenericSetup/rolemap.py index 5c6f460..fa0b2be 100644 --- a/src/Products/GenericSetup/rolemap.py +++ b/src/Products/GenericSetup/rolemap.py @@ -55,7 +55,8 @@ def importRolemap(context): version="20040518-01" handler="Products.GenericSetup.rolemap.importRolemap" title="Role / Permission import" - >Import additional roles, and map roles to permissions. + >Import additional roles, and map roles to permissions. + """ site = context.getSite()