nest-simulator icon indicating copy to clipboard operation
nest-simulator copied to clipboard

Doc doesn't mention `t_ref` of `hh_psc_alpha`

Open babsey opened this issue 2 years ago • 1 comments

Describe the flaw The user documentation doesn't mention t_ref of hh_psc_alpha (See the code https://github.com/nest/nest-simulator/blob/master/models/hh_psc_alpha.h#L91).

The question is, can the user set the value of t_ref?

Suggest an improvement Add a line in doc for the parameter t_ref or remove the parameter from the model. However the parameter t_ref seems to be used in the code (https://github.com/nest/nest-simulator/blob/master/models/hh_psc_alpha.cpp#L380).

babsey avatar May 25 '22 10:05 babsey

Issue automatically marked stale!

github-actions[bot] avatar Aug 27 '22 08:08 github-actions[bot]

@babsey Could you create a PR?

heplesser avatar Nov 25 '22 15:11 heplesser

Rather not, because I do not know which one is the preferred choice.

To remove the mentioned doc or to add the parameter instance?

babsey avatar Nov 28 '22 16:11 babsey

@babsey The user can set t_ref, so there should be documentation, the same as for other models with that parameter. Could you create a PR and also check the other hh_* models if they need documentation for this parameter as well?

heplesser avatar Nov 29 '22 15:11 heplesser

Issue automatically marked stale!

github-actions[bot] avatar Jan 29 '23 08:01 github-actions[bot]