Add editorial content on parameter and variable #53
Conversation
sandcha
changed the title
|
|
||
| # This allowance was introduced on the 1st of Jan 1980. Calculating it before this date will always return the variable default value, 0. | ||
| def formula_1980(household, period, parameters): | ||
| '''This is my specific life statement.''' |
There was a problem hiding this comment.
Not sure I understand this sentence.
Realistic examples (instead of "my variable"-like ones) are easier to understand :)
There was a problem hiding this comment.
Suggestion:
- In the variable documentation, mention that this benefit appeared in 1980 and disappeared in Dec 2016.
- In the formula doc, mention the dependency on 'rent'
There was a problem hiding this comment.
Done. I agree on realistic examples. I simply lacked inspiration. 🙂
| unit = 'currency-EUR' | ||
| documentation = ''' | ||
| This allowance was introduced on the 1st of Jan 1980. | ||
| It needs the 'rent' value (same month) but doesn't care about the 'housing_occupancy_status'. |
There was a problem hiding this comment.
👍, this kind of information adds a lot of value I think.
I'd maybe explicit a little more what we mean by "It needs":
To compute this allowance, the 'rent' value must be provided for the same month, but ''housing_occupancy_status'' is not necessary
| @@ -1,3 +1,4 @@ | |||
| # This (optional) file defines metadata for the node parameters.benefits in the parameter tree. | |||
|
|
|||
| description: Social benefits | |||
| documentation: This (optional) file defines metadata for the node parameters.benefits in the parameter tree. | |||
There was a problem hiding this comment.
Same than below, a realistic example would be much better.
Maybe a generic definition of social benefits?
Suggestion (extracted from this Wikipedia page)
Government support for the citizens and residents of society. They may be provided to people of any income level, as with social security, but usually it is intended to ensure that everyone can meet their basic human needs such as food and shelter.
CHANGELOG.md
Outdated
| * Minor change | ||
| * Details: | ||
| - Add `documentation` to parameters: `benefits` node and `benefits/housing_allowance` | ||
| - Add `documentation` to `housing_allowance` variable and docstring to its formula |
There was a problem hiding this comment.
To stay at a functional level, I'd just write:
Add
documentationtohousing_allowancevariable and its formula
as the docstring is also documentatiob
sandcha
force-pushed
the
editorialized-model-le124
branch
from
86ae286 to
f88bf29
Compare
sandcha
force-pushed
the
editorialized-model-le124
branch
from
f88bf29 to
9da2ca1
Compare
fpagnoux
force-pushed
the
editorialized-model-le124
branch
from
879e049 to
ec275df
Compare
Connected to openfisca/legislation-explorer#124
Note :
This branch was necessary to test openfisca/openfisca-core#717
Nevertheless, the question is: what do we want to keep as documentation example for new countries? 🙂
parameters/benefits,parameters/benefits/housing_allowanceandvariables/benefitsdocumentationto parameters:benefitsnode andbenefits/housing_allowancedocumentationtohousing_allowancevariable and docstring to its formulaThese changes: