HARK icon indicating copy to clipboard operation
HARK copied to clipboard

ConsIndShockModelFast.solution_fast documentation is messed up

Open llorracc opened this issue 4 years ago • 3 comments

It seems to be incorporating internal stuff into the documentation:

Click on 'https://hark.readthedocs.io/en/latest/reference/ConsumptionSaving/ConsIndShockModelFast.html?highlight=solution_fast#HARK.ConsumptionSaving.ConsIndShockModelFast.IndShockSolution

A textual description of the solution

llorracc avatar Feb 27 '21 22:02 llorracc

Not sure what you are referring to. Is it the long string of numbers in the in the docstring?

It looks like the np.linspace default argument is being interpreted before the docs are rendering.

https://github.com/econ-ark/HARK/blob/master/HARK/ConsumptionSaving/ConsIndShockModelFast.py#L156-L157

As far as I know, that could be expected behavior.

sbenthall avatar Feb 28 '21 01:02 sbenthall

Yes, long string of # but no other content does not seem like expected behavior

On Sat, Feb 27, 2021 at 8:12 PM Sebastian Benthall [email protected] wrote:

Not sure what you are referring to. Is it the long string of numbers in the in the docstring?

It looks like the np.linspace default argument is being interpreted before the docs are rendering.

https://github.com/econ-ark/HARK/blob/master/HARK/ConsumptionSaving/ConsIndShockModelFast.py#L156-L157

As far as I know, that could be expected behavior.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/econ-ark/HARK/issues/970#issuecomment-787214410, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAKCK7YY32QQ3PAEGE75SKDTBGJ77ANCNFSM4YKMU4IA .

-- Sent from Gmail Mobile

llorracc avatar Feb 28 '21 10:02 llorracc

https://docs.econ-ark.org/reference/ConsumptionSaving/ConsIndShockModelFast.html#HARK.ConsumptionSaving.ConsIndShockModelFast.IndShockSolution looks fine (if we ignore the long list of numbers). We can fix that by moving the variable declaration inside the function.

MridulS avatar Apr 18 '24 17:04 MridulS