pyjanitor-devs / pyjanitor

Clean APIs for data cleaning. Python implementation of R package Janitor

https://pyjanitor-devs.github.io/pyjanitor

MIT License

1.37k stars 170 forks source link

Improve rendered functions in Mkdocs #1388

Closed samukweku closed 3 months ago

samukweku commented 4 months ago

PR Description

Please describe the changes proposed in the pull request:

Improve rendering of functions in mkdocs
comment out strings that should not be rendered
ensure functions are grouped appropriately

This PR improves the rendered functions in mkdocs.

PR Checklist

Please ensure that you have done the following:

[x] PR in from a fork off your branch. Do not PR from <your_username>:dev, but rather from <your_username>:<feature-branch_name>.
[x] If you're not on the contributors list, add yourself to AUTHORS.md.
[ ] 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.

@ericmjl

ericmjl commented 4 months ago

🚀 Deployed on https://deploy-preview-1388--pyjanitor.netlify.app