improved docstrings #30
Open
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
Pull Request Test Coverage Report for Build 182
💛 - Coveralls |
2 similar comments
Pull Request Test Coverage Report for Build 182
💛 - Coveralls |
Pull Request Test Coverage Report for Build 182
💛 - Coveralls |
Pull Request Test Coverage Report for Build 183
💛 - Coveralls |
|
This is a good start. The docs should look more like this: https://github.com/apertium/streamparser/blob/master/streamparser.py#L187 So that they can be used to generate a pretty HTML page. |
|
@sushain97 Alright I'll change all the docstrings to that format ! |
|
@sushain97 I've updated the docstrings. I'll cover more functions if required. How do these look? |
sushain97
requested changes
Jul 25, 2018
| def update_modes(pair_path): # type: (str) -> None | ||
| modes = search_path(pair_path) | ||
| def update_modes(path): # type: (str) -> None | ||
| """Updates the install modes |
| Args: | ||
| path(str): A string that is the absolute location to the modes to be installed | ||
| Yelids: |
There was a problem hiding this comment.
Yelids => Yields
This won't be picked up by the parser.
Moreover, it should probably be returns.
Actually, does it even return anything?
| """Updates the install modes | ||
| Args: | ||
| path(str): A string that is the absolute location to the modes to be installed |
There was a problem hiding this comment.
This doesn't make it clear that this path will be added, the old ones won't be removed.
|
|
||
|
|
||
| class Analyzer: | ||
| """An Analyzer object containing it's analysis mode and langugage |
| """Updates the install modes | ||
| Args: | ||
| path(str): A string that is the absolute location to the modes to be installed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
@sushain97 Docstring isolated PR