Improve interface documentation #56
Merged
Conversation
This file contains 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
dataflake
approved these changes
Dec 2, 2021
icemac
force-pushed
the
fix_interface_docstring
branch
from
0cce303
to
b57b30b
Compare
|
Rebased unto |
icemac
approved these changes
Dec 7, 2021
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.
Working on zopefoundation/AccessControl#120
I found that the Python implementation of
Acquisitionhas a bug inaq_acquirewhen a filter is involved. To create a failing test, I looked for documentation about filters foraq_acquire. My first choice in such a case is always the interface description butAcquisition.interfaceswas not very informative.This PR improves the interface documentation: it adds a reference to https://github.com/zopefoundation/Acquisition#readme and copies parts thereof into the interface description (slightly reworded). The intention is that reading the interface typically provides all relevant information without the need to look elsewhere.