Provide guidance on parameters and variables with the same name
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
The issue names no files, tests, or entry points to inspect. Compare the three naming and variable-design examples, then document a decided convention for parameters and variables with the same name, including when the convention is considered complete.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
For example, consider the case of identifying whether a household is in poverty, where poverty line is indexed by household size. The formula could include Python variables that both represent the poverty line parameter (which is indexed by household size) and the household's poverty line based on their specific household size. I see three ways to address this:
A: Add a qualifier to the entity's value, e.g. household_
class is_in_poverty(Variable):
def formula(household, period, parameters):
poverty_line = parameters(period).poverty.poverty_line
household_size = household.nb_persons()
household_poverty_line = poverty_line[household_size]
return household("household_income") < household_poverty_line
B: Add a qualifier to the parameter, e.g. param_ or p_
class is_in_poverty(Variable):
def formula(household, period, parameters):
param_poverty_line = parameters(period).poverty.poverty_line
household_size = household.nb_persons()
poverty_line = poverty_line[household_size]
return household("household_income") < poverty_line
C: Add a separate OpenFisca variable for any parameter indexed by household features
class household_poverty_line(Variable):
def formula(household, period, parameters):
poverty_line = parameters(period).poverty.poverty_line
household_size = household.nb_persons()
return poverty_line[household_size]
class is_in_poverty(Variable):
def formula(household, period, parameters):
return household("household_income") < household("household_poverty_line")
Option C creates a lot of variables, but it seems cleanest to me. I think it would avoid the issue of potentially overlapping variables to represent parameters and Variables, but there might be some cases I'm not thinking of.
- Lenguaje dominante
- Makefile
- Estrellas
- 1
- Forks
- 3
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de PolicyEngine/policyengine.dev
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 38/100
PolicyEngine/policyengine.dev#19 · 1 comentario ·
-
Add API documentation Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 20/100
Todos los issues de PolicyEngine/policyengine.dev
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
certification
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
bisq-network/support#2181 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
tutorial updates Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
sveltejs/svelte.dev#2241 ·