Enrich public API docstrings for autodoc and IDE help#132
Merged
Conversation
The docstrings of the most-used testing helpers and layer classes were thin one-liners: applyProfile documented none of its six parameters, cleanUpMultiPlugins had no docstring at all, and IntegrationTesting / FunctionalTesting said only 'Plone version of the ... testing layer'. Enrich login, logout, setRoles, applyProfile, cleanUpMultiPlugins, IntegrationTesting and FunctionalTesting with parameter descriptions (reST field lists) and behaviour notes. No behaviour change, docstrings only. This is groundwork for an autodoc-generated API reference in the Plone documentation, and improves IDE help in the meantime.
|
@jensens thanks for creating this Pull Request and helping to improve Plone! TL;DR: Finish pushing changes, pass all other checks, then paste a comment: To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically. Happy hacking! |
Member
Author
|
@jenkins-plone-org please run jobs |
gforcada
approved these changes
Jul 17, 2026
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
3 participants
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.
Why
The docstrings on the most-used public API are thin one-liners.
applyProfiledocumented none of its six parameters,cleanUpMultiPluginshad no docstring at all, andIntegrationTesting/FunctionalTestingsaid only "Plone version of the … testing layer".This is groundwork for an autodoc-generated API reference in the Plone documentation (the testing chapter started in plone/documentation#2094): autodoc can only be as good as the docstrings. It also improves IDE help right now.
What
Docstrings only — no behaviour change. Enriched with descriptive prose and reST field lists:
login:param:; clarifies login name vs. user idlogoutloginsetRoles:param:; clarifies user id vs. login nameapplyProfilepurge_old,ignore_dependencies,archive,blacklisted_steps); notes theprofile-prefix is added internallycleanUpMultiPluginsIntegrationTestingFunctionalTestingWSGI_SERVER_FIXTUREnote for real HTTPNote for review
I introduced
:param:field lists, where the neighbouring docstrings use plain prose. The reason is the autodoc reference: field lists render as clean parameter tables. If you would rather keep plain prose, I am happy to change it.🤖 Generated with Claude Code