#178 util.Policy mapping documentation is incomplete & incomprehensible
Closed: Fixed None Opened 6 years ago by jdennis.

ipsilon.util.policy.Policy implements a mapping mechanism. The documentation for the Policy object is barely comprehensible and has little to do with the implementation.

Scroll to the bottom of policy.py and look at the unit test with it's input values and results. Now go back to the documentation and try to correlate the results given the input. It doesn't seem to be related to the documentation at all.

For example prefixes play a crucial role in the mapping operation but are never mentioned in the documentation.

Fields changed

milestone: => 1.3

Fields changed

owner: => merlinthp
status: new => accepted

PR 113 opened with proposed fix

PR 113 merged.

resolution: => fixed
status: accepted => closed

Metadata Update from @merlinthp:
- Issue assigned to merlinthp
- Issue set to the milestone: 1.3

4 years ago

Login to comment on this ticket.