Add module level docstrings in the documentation #26
Conversation
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
willrogers
reviewed
Jun 1, 2017
| @@ -1,3 +1,5 @@ | |||
| """ Class to load the elements of the machine from a csv file.""" | |||
|
|
|||
Collaborator
There was a problem hiding this comment.
Do you know what the difference between a 'module' and a 'class' is?
Contributor
Author
There was a problem hiding this comment.
The module can contain multiple routines or different classes. My bad for calling it a class instead of a module.
willrogers
reviewed
Jun 1, 2017
| @@ -1,3 +1,5 @@ | |||
| """ Module to load the elements of the machine from a csv file.""" | |||
|
|
|||
Collaborator
There was a problem hiding this comment.
It might be worth saying that you load machine data from multiple CSV files in a single directory.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
No description provided.