text not very clear in the apidoc
Bug #161737 reported by
Christophe Combelles
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Zope 3 |
Fix Released
|
Undecided
|
Philipp von Weitershausen | ||
Bug Description
While reviewing the translation of zope3, I found some string in the apidoc which is not very clear, and can lead to potentially dangerous translations (ie which can be false or mistaken). I think having water-clear text in the apidoc is important, since the concepts are not obvious for beginners.
In zope/app/
One can read: "Adapters where this interface is required:"
It seems that
The real meaning is:
"Registered adapters available for objects implementing this interface"
So the interface is not really required by the adapter itself, but required to be implemented by the object the adapter adapts.
So to be short, the string should be:
"List of adapters registered for this interface".
Revision history for this message
| Philipp von Weitershausen (philikon) wrote | #1 |
| Changed in zope3: | |
| assignee: | nobody → philipp-weitershausen |
| status: | New → Confirmed |
Revision history for this message
| Philipp von Weitershausen (philikon) wrote | #2 |
| Changed in zope3: | |
| status: | Confirmed → Fix Released |
Revision history for this message
| Stephan Richter (srichter) wrote | #3 |
To post a comment you must log in.
I'll take this one. Note that "Adapters registered for this interface" is a bit ambiguous (which is probably why the weird original wording was chosen). I suggest to use "Adapters for objects providing this interface" instead.