[MRG] Improve docstrings: add them for Constraints class and methods and fix minor problems #280
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
|
Actually, there are still quite a few small problems in docstrings of many classes, in particular with default values. I will fix those as well |
bellet
changed the title
|
I have also fixed indentation issues in docstrings, and uniformized the indentation |
|
I was still fixing a few small problems - sorry, I should have switched back to WIP. Will create a new PR |
perimosocordiae
pushed a commit
that referenced
this pull request
Mar 4, 2020
* add docstrings for constraints class, pairs and chunks methods * fix missing optional values and descriptions, uniformize * fix indentation problems in docstring and uniformize * fix more small things * cosmit * remove unnecessary line * missing blank line for pep8
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 PR adds some docstrings for the
Constraintsclass and itspositive_negative_pairsandchunksmethods.It also fixes minor docstring problems, such as missing description or default values, and indentation problems.
Combined with the doc improvements already made in #274, I think this resolves #227