Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Normalise code examples #111

Open
2 of 12 tasks
bonjourmauko opened this issue Jan 25, 2018 · 2 comments
Open
2 of 12 tasks

Normalise code examples #111

bonjourmauko opened this issue Jan 25, 2018 · 2 comments
Assignees

Comments

@bonjourmauko
Copy link
Member

bonjourmauko commented Jan 25, 2018

There are some examples in the documentation that are written for the country-template while other are for openfisca-france.

Imagine the terrified face of users when they see this.

It should be improved :

  • Fix variables naming section
  • Update "writing YAML tests"
  • Reword "The system for France is currently the only one well implemented" in key-concepts/tax_and_benefit_system (it's not super friendly)
  • Don't equate two unrelated concepts in key-concepts/variables: "basic income (in France, RSA)"
  • Don't mention Paris specifically, use a generic concept like "postal code" in key-concepts/variables
  • Use the country template entities as examples rather than France, in key-concepts/person,_entities,_role
  • Ditto for roles
  • Improve the section title "Application: module used by OpenFisca" in key-concepts/person,_entities,_role
  • use country template variables in key-concepts/input_data
  • use a country template test case in key-concepts/input_data
  • don't recommend using the "modality" of an enum in key-concepts/input_data
  • use a country template example in key-concepts/simulation
@MattiSG
Copy link
Member

MattiSG commented May 18, 2018

It seems quite obvious to me that examples should be from the Country template.

@verbman
Copy link
Contributor

verbman commented May 19, 2024

3rd item: Reword... addressed in PR https://github.com/openfisca/openfisca-doc/pull/301/files#diff-ffeda9bf12e2edbe63656ef879a256f4493d51d64f8bd04deb8e29e8981d13dcR17

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

6 participants