-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation to ParameterStorage #807
Conversation
@sjoerd-bouma can you hint me to what goes wrong with the docu? |
Our classes automatically link to their Base class, if they inherit from one; but because _ParameterStorage is now private this cross-reference is broken. I am still thinking about how this should be solved. If you want to merge the |
If we make the ParameterStorage private, we hide the description of the parameter storage from the user. Is that something we really want? |
Not really - inherited methods are still documented. Maybe just having a submodule (yes, let's go down another level!) in framework for classes that are used to inherit from, but not meant to be used directly in user code, would help to distinguish as well. Or just a module docstring in parameter_storage that explains that this class is used for inheritance only. |
The deepcopy was already merged with PR #815 |
@sjoerd-bouma, I reverted the changes to the class "type". This PR now only updates the doc-strings in the class. |
ping |
Can we merge this? @sjoerd-bouma |
Since this PR only improves on the doc-strings I am merging this right away. |
… by deep copy.