Skip to content

Fix validation error type RT01 and check in CI #25356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
2 tasks
MarckK opened this issue Feb 17, 2019 · 5 comments · Fixed by #26234
Closed
2 tasks

Fix validation error type RT01 and check in CI #25356

MarckK opened this issue Feb 17, 2019 · 5 comments · Fixed by #26234
Labels
CI Continuous Integration Code Style Code style, linting, code_checks Docs good first issue
Milestone

Comments

@MarckK
Copy link
Contributor

MarckK commented Feb 17, 2019

Problem description

In order to have a continuous check by the CI on validation error RT01 (No Returns section found), fixing them in the code base enables the addition to the CI for automated testing in the future.

Please see overview of the errors.

Todo:

  • get rid of the errors in the code base
  • update the code_check.sh script to take into account the RT01 type of errors
@gfyoung gfyoung added Docs CI Continuous Integration Code Style Code style, linting, code_checks labels Feb 18, 2019
@souvik3333
Copy link
Contributor

I would like to work on this. But I have a doubt. What should I return so that the error gets fixed?

@gfyoung
Copy link
Member

gfyoung commented Feb 21, 2019

@ihsansecer
Copy link
Contributor

I could take this issue if nobody is working on it.

ihsansecer added a commit to ihsansecer/pandas that referenced this issue Apr 27, 2019
Except errors in accessor.py, op.py and some errors in resample.py, frame.py
ihsansecer added a commit to ihsansecer/pandas that referenced this issue Apr 27, 2019
ihsansecer added a commit to ihsansecer/pandas that referenced this issue Apr 27, 2019
ihsansecer added a commit to ihsansecer/pandas that referenced this issue Apr 28, 2019
@ihsansecer
Copy link
Contributor

@gfyoung In the docstring of itertuples function, it is explained that it yields namedtuples but it seems to return an iterator of namedtuples. This causes a validation error RT01. Other iter* functions seems to yield rather than return. Should I change yield to return in the docstring?

@gfyoung
Copy link
Member

gfyoung commented Apr 28, 2019

Yes, do correct the docstring section for itertuples.

ihsansecer added a commit to ihsansecer/pandas that referenced this issue Apr 28, 2019
ihsansecer added a commit to ihsansecer/pandas that referenced this issue Apr 28, 2019
ihsansecer added a commit to ihsansecer/pandas that referenced this issue Apr 28, 2019
ihsansecer added a commit to ihsansecer/pandas that referenced this issue Apr 28, 2019
@jreback jreback added this to the 0.25.0 milestone Apr 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Code Style Code style, linting, code_checks Docs good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants