TST: Allow for multiple variables on the same line in docstring validation #28811
+59
−10
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
Allow for multiple variables to share the same type and description in documentation. For example, `i, j, k : int` Would be three variables, i, j, and k, which are all ints.
This was generating errors because it got fixed in master after I made the branch. I'm sure this will be a merge conflict, and I can work it out there first.
WillAyd
requested changes
Oct 7, 2019
Added a test for if the spacing is off on a multivariable oneline parameter descriptoin
I put in a test for if spacing is off. Other than that, it's a little hard to test because I can't have a test with more than one wrong parameter. The validation script uses sets, so the order can change between runs. |
|
Can you not put a test in |
|
Oh, yeah. I'll do that real quick. Sorry, didn't cross my mind. |
Adds a test for if multiple variables are typed and described on the same line in a docstring.
WillAyd
requested changes
Oct 10, 2019
There was a problem hiding this comment.
minor comment otherwise lgtm @datapythonista if you have any thouhts
Removed the functionality of tests, since it isn't important for documentation. Fixed a couple of small typos.
WillAyd
approved these changes
Oct 10, 2019
jorisvandenbossche
approved these changes
Oct 10, 2019
|
Thanks @Nabel0721 ! |
ChiefMilesEdgeworth
deleted the
Documenation_oneline_multivariable_description
branch
proost
pushed a commit
to proost/pandas
that referenced
this pull request
Dec 19, 2019
proost
pushed a commit
to proost/pandas
that referenced
this pull request
Dec 19, 2019
bongolegend
pushed a commit
to bongolegend/pandas
that referenced
this pull request
Jan 1, 2020
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.
Allow for multiple variables to share the same type and description in documentation. For example,
i, j, k : intWould be three variables, i, j, and k, which are all ints.black pandasgit diff upstream/master -u -- "*.py" | flake8 --diff