Skip to content

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

Merged
merged 12 commits into from
Aug 13, 2021
Merged

Doc updates #865

merged 12 commits into from
Aug 13, 2021

Conversation

loganthomas
Copy link
Member

@loganthomas loganthomas commented Aug 12, 2021

PR Description

Please describe the changes proposed in the pull request:

Screen Shot 2021-08-11 at 22 11 43

  • Late addition: strips as_categorical() references in light of encode_categorical()

PR Checklist

Please ensure that you have done the following:

  1. PR in from a fork off your branch. Do not PR from <your_username>:dev, but rather from <your_username>:<feature-branch_name>.

  2. If you're not on the contributors list, add yourself to AUTHORS.rst.

  3. Add a line to CHANGELOG.md under the latest version header (i.e. the one that is "on deck") describing the contribution.

    • Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.

Automatic checks

There will be automatic checks run on the PR. These include:

  • Building a preview of the docs on Netlify
  • Automatically linting the code
  • Making sure the code is documented
  • Making sure that all tests are passed
  • Making sure that code coverage doesn't go down.

Relevant Reviewers

Please tag maintainers to review.

@loganthomas
Copy link
Member Author

@ericmjl and @samukweku
One thing I noticed when building the docs, janitor.as_categorical is no longer a function. Did this get replaced withjanitor.encode_catecorical?

Error message:

WARNING: [autosummary] failed to import 'janitor.as_categorical': no module named janitor.as_categorical

If this is true, I'd like to clean this up within this PR. Thanks!

@codecov
Copy link

codecov bot commented Aug 12, 2021

Codecov Report

Merging #865 (a6ad1ad) into dev (b1f601c) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            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     

@loganthomas loganthomas self-assigned this Aug 12, 2021
Copy link
Collaborator

@samukweku samukweku left a 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.

@samukweku
Copy link
Collaborator

@loganthomas it seems the docs don't align with the most recent docs in the repo.

@loganthomas
Copy link
Member Author

@loganthomas yes, as_categorical is superseded by encode_categorical.

Thanks @samukweku! Updated and stripped ✂️

@loganthomas
Copy link
Member Author

@loganthomas it seems the docs don't align with the most recent docs in the repo.

@samukweku Are you building the docs locally? Or, do you mean from https://pyjanitor-devs.github.io/pyjanitor/?

@loganthomas loganthomas added the docfix Documentation fixes needed label Aug 13, 2021
@samukweku
Copy link
Collaborator

@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 dev.

By the way, I am learning from your updates on this ticket (learning a lot about devops through your work!)

@loganthomas
Copy link
Member Author

@samukweku can you provide an example of the docs that aren't aligned? This PR hasn't been merged to dev so the changes won't be reflected in production yet.

@samukweku
Copy link
Collaborator

@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>`_
Copy link
Member

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!

@ericmjl
Copy link
Member

ericmjl commented Aug 13, 2021

Not worried about Codecov for the time being, looks minor to me. Let's merge!

@ericmjl
Copy link
Member

ericmjl commented Aug 13, 2021

Btw, I think netlify page previews are broken, will see if I can get to it tomorrow.

@loganthomas
Copy link
Member Author

@samukweku @ericmjl thank you both for the review!

@loganthomas loganthomas merged commit 1db9498 into pyjanitor-devs:dev Aug 13, 2021
@loganthomas loganthomas deleted the doc-updates branch August 13, 2021 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docfix Documentation fixes needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants