Skip to content

Fix malformed docstring for rolemap.importRolemap#141

Merged
stevepiercy merged 3 commits into
masterfrom
fix-docsting-importRolemap
May 13, 2026
Merged

Fix malformed docstring for rolemap.importRolemap#141
stevepiercy merged 3 commits into
masterfrom
fix-docsting-importRolemap

Conversation

@stevepiercy
Copy link
Copy Markdown
Contributor

@stevepiercy stevepiercy commented May 13, 2026

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.

Screenshot 2026-05-13 at 4 19 30 AM
  • I signed and returned the Zope Contributor Agreement, and received and accepted an invitation to join a team in the zopefoundation GitHub organization.
  • I verified there aren't any other open pull requests for the same change.
  • I followed the guidelines in Developer guidelines.
  • I successfully ran code quality checks on my changes locally.
  • I successfully ran tests on my changes locally.
  • If needed, I added new tests for my changes.
  • If needed, I added documentation for my changes.
  • I included a change log entry in my commits.

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

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.
@stevepiercy stevepiercy merged commit 54d1062 into master May 13, 2026
15 checks passed
@stevepiercy stevepiercy deleted the fix-docsting-importRolemap branch May 13, 2026 12:14
@stevepiercy
Copy link
Copy Markdown
Contributor Author

If it's not too much effort, would you please create a release so that we can publish these changes? Thank you!

@dataflake
Copy link
Copy Markdown
Member

Version 5.2 is now released

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants