Decide how to apply qe-fig-003 (no matplotlib titles) across the lectures

Abierto
  • ¿Algo no está bien?
#398 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
matplotlib, python
Área
documentation

Línea de trabajo

Read qe-fig-003 in the action-style-guide and review the counts by lecture in the issue. Compare the two proposed policies, including how they handle panel descriptions and single-panel figures. Done means the project has decided whether to add a multi-panel exception or enforce the existing rule across the listed lectures.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

style-guide

The QuantEcon style guide's rule qe-fig-003 says figures should not embed titles with ax.set_title() or fig.suptitle() outside exercises and solutions; the mystnb caption carries the title instead. The review of #396 found four figures in the two new lectures that use panel titles, but the pattern is repo-wide, so it needs a decision before any changes.

Scope

Counted on the oct_seoul branch (main plus the two new lectures). Each count is the number of lines calling set_title or suptitle outside exercise and solution blocks, so a loop that titles several panels counts once.

  • 33 of 75 lectures, 148 lines.
  • Most hits title the panels of multi-panel figures, where one caption can't label every panel. The counts don't yet separate single-panel figures from multi-panel ones.

The four figures from #396:

  • gradual_trade_agreements: fig-gta-frontier (a title per parameter case) and fig-gta-smoothing (three panel titles)
  • organizational_equilibrium: fig-oe-growth-paths (four panel titles) and fig-oe-chi-G (two panel titles)
Counts by lecture
Lecture Lines
induced_priors 15
additive_functionals 11
tax_smoothing_2 9
dovis_accounting_mf 9
BCG_incomplete_mkts 9
policy_counterfactuals_nk 7
policy_counterfactuals 7
tsyrennikov_2013 6
hs_invertibility_example 6
smoothing_tax 5
five_preferences 5
cattle_cycles 5
tax_smoothing_3 4
supply_demand_var 4
smoothing 4
rosen_schooling_model 4
markov_jump_lq 4
black_litterman 4
policy_regimes 3
organizational_equilibrium 3
muth_kalman 3
dyn_stack 3
policy_invertibility 2
gradual_trade_agreements 2
gorman_heterogeneous_households 2
chang_ramsey 2
calvo 2
BCG_complete_mkts 2
atkeson_1991 2
opt_tax_recur 1
estspec 1
discrete_dp 1
cagan_rational_expectations 1
Options
  1. Enforce the rule as written. Move each panel's description into its y-axis label, and use a legend title or annotation where panels differ by parameter case. Sweep all 33 lectures.
  2. Allow panel titles in multi-panel figures. This needs an exception added to qe-fig-003 in action-style-guide. Only single-panel figures would then need changing, and the style checker would stop flagging multi-panel figures.

Option 2 matches current practice and is much smaller. Option 1 keeps the rule simple but touches nearly half the lectures.

Lenguaje dominante
TeX
Estrellas
38
Forks
27
Merge medio
7 h 38 min
PR fusionados (30 d)
9

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de QuantEcon/lecture-python-advanced.myst

Todos los issues de QuantEcon/lecture-python-advanced.myst

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.