documentation for 'new' models; better docs for 'old' models

[sbenthall]

There are now two kinds of models in the HARK repository:

• (A) Ones in `HARK/ConsumptionSaving', which are of the original style
• (B) Ones in HARK/model, which are of a new style, based on blocks and working towards HARK 1.0/2.0

The models in (B) make their 'equations' clear by virtue of the fact that that's all they are -- collections of model data that is, effectively, their equations. But they do not yet have rendered autodocs because I forgot to write them, and because I'm uncertain about the documentation standards.

The models in (A) have autodocs rendered to Sphinx. But these docs do not contain the model equations. If these equations are anywhere, they are in example notebooks, maybe? This seems less than ideal, since it would be nice to know what equations a model was working with.

This is related to #1292 and #479 and the general idea that it should be possible to find something like the equations for the models in HARK.

I guess the concrete proposal is that we agree to include model equations in model documentation.

I would then go add docs for the 'new' models.

[DominicWC]

This is partially addressed by pr#1470, but is still an issue at the moment.

[mnwhite]

Dominic is already working on this.

…

On Mon, Jun 3, 2024, 10:02 AM Sebastian Benthall ***@***.***> wrote: There are now two kinds of models in the HARK repository: - (A) Ones in `HARK/ConsumptionSaving', which are of the original style - (B) Ones in HARK/model, which are of a new style, based on blocks and working towards HARK 1.0/2.0 The models in (B) make their 'equations' clear by virtue of the fact that that's all they are -- collections of model data that is, effectively, their equations. But they do not yet have rendered autodocs because I forgot to write them, and because I'm uncertain about the documentation standards. The models in (A) have autodocs rendered to Sphinx. But these docs do not contain the model equations. If these equations are anywhere, they are in example notebooks, maybe? This seems less than ideal, since it would be nice to know what equations a model was working with. This is related to #1292 <#1292> and #479 <#479> and the general idea that it should be possible to find something like the equations for the models in HARK. — Reply to this email directly, view it on GitHub <#1439>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADKRAFLJNMJKKHT33GHOC33ZFRZORAVCNFSM6AAAAABIWSRSSOVHI2DSMVQWIX3LMV43ASLTON2WKOZSGMZTCMRUGM3TMNA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>