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

Aperta
  • Qualcosa non va?
#398 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
matplotlib, python
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TeX
Stelle
38
Fork
27
Merge medio
7h 38m
PR unite (30g)
9

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di QuantEcon/lecture-python-advanced.myst

Tutte le issue di QuantEcon/lecture-python-advanced.myst

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.