Skip to content
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

Merged
merged 5 commits into from
Feb 4, 2025
Merged

Conversation

fschlueter
Copy link
Collaborator

… by deep copy.

@fschlueter
Copy link
Collaborator Author

@sjoerd-bouma can you hint me to what goes wrong with the docu?

@sjoerd-bouma
Copy link
Collaborator

@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 deepcopy fix separately I'm happy to approve that.

@fschlueter
Copy link
Collaborator Author

@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 deepcopy fix separately I'm happy to approve that.

If we make the ParameterStorage private, we hide the description of the parameter storage from the user. Is that something we really want?

@sjoerd-bouma
Copy link
Collaborator

@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 deepcopy fix separately I'm happy to approve that.

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.

@fschlueter fschlueter changed the title Make ParameterStorage class private. Add doc strings. Replace shallow… Add documentation to ParameterStorage Jan 29, 2025
@fschlueter
Copy link
Collaborator Author

The deepcopy was already merged with PR #815

@fschlueter
Copy link
Collaborator Author

@sjoerd-bouma, I reverted the changes to the class "type". This PR now only updates the doc-strings in the class.

@fschlueter
Copy link
Collaborator Author

ping

@fschlueter
Copy link
Collaborator Author

Can we merge this? @sjoerd-bouma

@fschlueter
Copy link
Collaborator Author

Since this PR only improves on the doc-strings I am merging this right away.

@fschlueter fschlueter merged commit ae42a42 into develop Feb 4, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants