You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
At the moment, the existing python interface is usable, but doesn't have great documentation. I often use jupyter's Shift+Tab keybindings to bring up docstrings for unfamiliar functions in order to better understand the purpose of each method. For NuSQuIDS, this currently brings up the default description showing the C++ signature, but not much less. For example, this, when trying to understand the Earth class:
At the moment, the existing python interface is usable, but doesn't have great documentation. I often use jupyter's
Shift+Tab
keybindings to bring up docstrings for unfamiliar functions in order to better understand the purpose of each method. For NuSQuIDS, this currently brings up the default description showing the C++ signature, but not much less. For example, this, when trying to understand theEarth
class:Adding python docstrings would help new users to understand the interface better and increase usability.
The text was updated successfully, but these errors were encountered: