HARK
HARK copied to clipboard
econ-ark
Editing things in the examples/ directory for consistency, articulating policy in documentation
@llorracc writes here: https://github.com/econ-ark/HARK/pull/472#issuecomment-582010196
I think you should remove the "Doc" from their names if they are being explicitly moved into an area that is already designated for documentation.
LifeCycleModelExample ... though if it does go into the "examples" area it should lose the "Example" from its filename.
It would be a good idea to go through the examples/ drrectory, which will be used for documentation with #459 / #472 , and edit those notebooks for consistency. This would include rationalizing the naming. This process can result in a "Style Guide", which should be part of the "Contribution Documentation". #410
Cleanup the structure of examples directory. Move example notebooks to ConsumptionSavings from individual folders.
I think it would be better to use Markdown's code format this like rather than the LaTeX texttt formatting
I see that making this change across all the examples is a bit complicated, as this is used widely, sometimes the code variable names are included in larger mathematical expressions, and the LaTeX formatting is used in the long parameter table lists. I see this as connected to issue #889 in that it reflects the ways HARK code has been written to crossover between LaTeX and Python. Maybe this aspect of the docs should be revisited when this is better sorted out conceptually.
Possibly something more nuanced is needed. code format for class and method names, keeping latex for the mathematical objects --- i"ll try to stick with that for 1.0
just getting the examples and demarks working is taking so much time, I can't do this by 1.0, especially because of notebook overwrites from other PRs.