Document Role

[bonjourmauko]

Technical changes

• Document Role.

[coveralls]

coverage: 74.115% (+0.08%) from 74.032% when pulling 8dec6b4 on document-role into 2c04dae on master.

[MattiSG]

Thanks @maukoquiroga!

I can't evaluate the relevance of the documentation itself. @benjello maybe?

[benjello]

@maukoquiroga could you run the openfisca-france test suite with this version of core so we stress test it in real conditions and avoid some problem down the roads.

[bonjourmauko]

@benjello :

2380 passed, 313 warnings in 873.19s (0:14:33)

[bonjourmauko]

Thanks @maukoquiroga!

I can't evaluate the relevance of the documentation itself. @benjello maybe?

Thanks @MattiSG . The documentation contains unit tests, maybe you could have an input on that.

[MattiSG]

At this stage, I see mostly syntax improvements, and addition of documentation. I prefer to switch to a shipping mindset and unblock this PR by applying the idea that some documentation is better than no documentation, and will approve even though I cannot guarantee the accuracy of the documentation contents themselves.

Thank you for your work and patience @maukoquiroga.

[bonjourmauko]

Thanks @MattiSG :) With lots of syntax improvements and doc, my hope is it'll be easier to propose and review big changes in the future without breaking things unadvertently.

[benjello]

@maukoquiroga : do you think this PR may produce this bug ?

[benjello]

See also #1194

[bonjourmauko]

Hi @benjello, at first view, no (but I encountered a similar issue while working in this PR). While #1194 is a first fix, Role continues to be non-hashable because its immutability can't be assured. Thanks for the fix!

[benjello]

#1194 fixed the trouble with the openfisca-survey-manager bug

[bonjourmauko]

After checking, in fact yes, sorry: this PR makes Role unhashable by giving it an __eq__. If a Role is intended to actually be hashable, then indeed __eq__ should be removed.

[bonjourmauko]

I'll propose a PR in 5m. I'll just add a test in the doc so we know Role is meant to be hashable. No need for the __hash__ method, just removing __eq__.