MDSuite icon indicating copy to clipboard operation
MDSuite copied to clipboard

Published 20 hours ago • verified publisher icon zincware

Not all calculators have auto doc strings in Jupyter

Open SamTov opened this issue 3 years ago • 1 comments

I have noticed that while pushing shift tab in Jupyter that some of the calculators such as coordination numbers, Einstein diffusion and very likely more do not have the doc stings shown and rather are just a property. This is not the case for calculators such as RDFs but it should be uniform across the board.

SamTov avatar Jan 28 '22 08:01 SamTov

They should all behave the same

https://github.com/zincware/MDSuite/blob/8f55d267b514e89c6392388b6ae5335670a34459/mdsuite/experiment/run.py#L162-L237

but I do think that they should be changed to e.g. -> Type[CoordinationNumbers] actually.

PythonFZ avatar Jan 28 '22 09:01 PythonFZ