Add situation example #38
Conversation
jvalduvieco
commented
Apr 14, 2018
jvalduvieco
commented
- Documentation improvement
- Details:
- Add a situation test example as in openfisca-barcelona is the main testing process and there is no example in the country template.
- Found a missing parameter in pension.
|
Arg, didn't see this PR, sorry @jvalduvieco, and thanks @MattiSG for asking the review. Will have a look at it tomorrow :). |
|
Sorry, I'm running out of time at the moment, but I swear I haven't forgotten about this PR :) |
There was a problem hiding this comment.
Thank you so much @jvalduvieco! I agree that not having an example of situation with multiple Persons has been confusing for newcomers. It feels like it's not possible to do such tests!
The feedback I have given is very extreme, as the country template has to be a “best practice” showcase, so we have to make sure it shows the very best recommendations.
I would totally understand if you did not have the time to take these change suggestions into account. If you don't feel like it, I can definitely take care of these small syntax changes for you as additional commits.
Let me know what's the best for you, and thanks again for your contribution!! 😃
| salary: | ||
| 2017-01: 2400 | ||
| - id: "child1" | ||
| birth: '2002-01-15' |
There was a problem hiding this comment.
As we want to give best practice examples, it seems important to me that we use a coherent style of quotes. If possible, no quotes at all would be the best if YAML does support it 🙂
| birth: '1961-01-15' | ||
| salary: | ||
| 2017-01: 2400 | ||
| - id: "child1" |
There was a problem hiding this comment.
Best practice: give real names in examples.
| @@ -0,0 +1,21 @@ | |||
| - name: "A single parent with a child situation" | |||
| description: A simple situation just to test | |||
There was a problem hiding this comment.
As a best practice example, we should be as clear and literate as possible (or not add a description at all). Maybe this test is about “Income tax should get properly computed across all members of a household”? 😃
| absolute_error_margin: 0 | ||
| households: | ||
| - parents: ["parent1"] | ||
| children: ["child1"] |
There was a problem hiding this comment.
I believe best readability practice includes internal spaces: [ parent1 ] is more readable than ["parent1"] 🙂
|
Comments fixed. :) |
|
Brilliant, thanks a lot @jvalduvieco! |
