Expand the Layer base class docstring - #134
Merged
Merged
Conversation
The class had only 'A base class for layers.'. Describe the setUp/tearDown and testSetUp/testTearDown lifecycle, the resource mapping (self[key]), and composition through bases. Groundwork for an autodoc-generated API reference in the Plone documentation. Docstring only, no behaviour change.
|
@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! |
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
2 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
plone.testing.layer.Layer— the base class of the whole testing-layer model — had a one-line docstring: "A base class for layers."This is groundwork for an autodoc-generated API reference in the Plone documentation (a testing chapter that documents both
plone.testingandplone.app.testing). autodoc can only be as good as the docstring.What
Docstring only, no behaviour change. The
Layerdocstring now describes:setUp/tearDown(once) andtestSetUp/testTearDown(per test) lifecycle;self[key] = value/self.layer[key]);bases/defaultBases.🤖 Generated with Claude Code