-
Notifications
You must be signed in to change notification settings - Fork 173
Doc updates #865
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
Doc updates #865
Conversation
@ericmjl and @samukweku Error message:
If this is true, I'd like to clean this up within this PR. Thanks! |
Codecov Report
@@ Coverage Diff @@
## dev #865 +/- ##
==========================================
- Coverage 94.89% 94.85% -0.05%
==========================================
Files 19 19
Lines 2078 2078
==========================================
- Hits 1972 1971 -1
- Misses 106 107 +1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@loganthomas yes, as_categorical is superseded by encode_categorical.
@loganthomas it seems the docs don't align with the most recent docs in the repo. |
Thanks @samukweku! Updated and stripped ✂️ |
@samukweku Are you building the docs locally? Or, do you mean from https://pyjanitor-devs.github.io/pyjanitor/? |
@loganthomas, locally, everything renders fine, but when I view it from https://pyjanitor-devs.github.io/pyjanitor/, the content is not up to date with By the way, I am learning from your updates on this ticket (learning a lot about |
@samukweku can you provide an example of the docs that aren't aligned? This PR hasn't been merged to |
@loganthomas no worries; I'm sure it will be resolved after the merge. thanks! |
@@ -29,6 +29,9 @@ Leads | |||
- Started pyspark sub-module. | |||
- `@anzelpwj <https://github.com/anzelpwj>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Aanzelpwj>`_ | |||
- `@samukweku <https://github.com/samukweku>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Asamukweku>`_ | |||
- `@loganthomas <https://github.com/loganthomas>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Aloganthomas>`_ | |||
- Helped others with ``git`` issues at SciPy 2019. | |||
- `@nvamsikrishna05 <https://github.com/nvamsikrishna05>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Anvamsikrishna05>`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 thank you for handling this, @loganthomas!
Not worried about Codecov for the time being, looks minor to me. Let's merge! |
Btw, I think netlify page previews are broken, will see if I can get to it tomorrow. |
@samukweku @ericmjl thank you both for the review! |
PR Description
Please describe the changes proposed in the pull request:
AUTHORS.rst
to reflect new pyjanitor-dev leadspivot_wider()
so that only top line in docstring is rendered. Currently, it looks like the below image:as_categorical()
references in light ofencode_categorical()
PR Checklist
Please ensure that you have done the following:
PR in from a fork off your branch. Do not PR from
<your_username>
:dev
, but rather from<your_username>
:<feature-branch_name>
.If you're not on the contributors list, add yourself to
AUTHORS.rst
.Add a line to
CHANGELOG.md
under the latest version header (i.e. the one that is "on deck") describing the contribution.Automatic checks
There will be automatic checks run on the PR. These include:
Relevant Reviewers
Please tag maintainers to review.