Fix malformed docstring for rolemap.importRolemap#141
Merged
Conversation
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.
dataflake
approved these changes
May 13, 2026
Contributor
Author
|
If it's not too much effort, would you please create a release so that we can publish these changes? Thank you! |
Member
|
Version 5.2 is now released |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docstring was malformed and invalid, resulting in Sphinx build errors in the main Plone documentation.
This PR fixes the docstrings, adding proper lexers. Now it looks purty.
See screenshot.
Refs: plone/documentation#2083 (review)
When merged, and docs are rebuilt in that PR, then preview the final result at https://plone6--2083.org.readthedocs.build/backend/generic-setup.html#Products.GenericSetup.rolemap.importRolemap