Update docstrings in io.py#81
Merged
Merged
Conversation
Member
|
Thanks @jmrohwer! The updated docstrings are great. Merging 🙌 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There are several methods in the
EnzymeMLHandlerclass that are exposed in the top-levelpenamespace. The docstrings of these methods were very cryptic, however, most of them directly call identically named methods from tabular.py, serializer.py or petab/io.py.This PR updates the docstrings with the more complete versions from the actual methods that are called, so that they are more accessible to the user during interactive use, e.g.
This provides, amongst others, additional information on the required structure of the CSV or Excel files, or pandas DataFrame, which are imported and makes it easier for the user to query this information without delving into the source code.
This change is