Feature/issue 373 #397
Merged
Feature/issue 373 #397
Conversation
This file contains 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
added 11 commits
November 28, 2017 14:22
…inor tweaks to docstrings for learner, metrics, and experiments
…to feature/issue-373
jbiggsets
requested review from
desilinguist,
aoifecahill,
a user,
mulhod and
Lguyogiro
|
This is ready for review. @desilinguist, I'm no longer getting any warnings when I generate the documentation with |
…com:EducationalTestingService/skll into feature/issue-373 Adding tests to ensure coverage is okay.
|
Okay, now that the coverage issue is resolved, I am going to start to review this. |
Lguyogiro
reviewed
Dec 11, 2017
skll/config.py
Outdated
| Returns | ||
| ------- | ||
| invalid_options : set | ||
| The set of invalid options specified by the user. |
There was a problem hiding this comment.
Do we want to specify the type of the set elements to expect? eg set of str. This change would apply to a lot of other functions as well.
There was a problem hiding this comment.
Yes, this seems like a nice thing to do.
- Replace `Note` with `Notes`. - Fix some boolean defaults. - Add more details about lists and sets.
- feature_set -> `FeatureSet` - Some other minor changes - Add new authors.
…ds, and (2) use single backticks
3 similar comments
Lguyogiro
approved these changes
Dec 11, 2017
- Use double backticks where possible to be consistent with the non-docstring documentation. - Fix some typos here and there. - Minor rephrasings.
- Some other minor changes.
desilinguist
approved these changes
Dec 12, 2017
|
@aoifecahill Once the build passes, this is just waiting for your approval. |
aoifecahill
approved these changes
Dec 12, 2017
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.
This is a PR to address #373. It updates all of the docstrings in the
skllpackage. There are two main types of changes:numpy-style. This sometimes involved adding additional information, such as any errors being raised or arguments the were not mentioned.numpy-style docstrings to functions and methods where none previously existed.I have also added the
sphinx.ext.napoleonextension to thedoc/config.pyfile to properly parsenumpy-style docstrings when generating documentation for RTD.Please review new docstrings especially carefully, with an eye toward proper argument and return data types.