Skip to content
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] Fix min_max_scale docstrings rendering #1123

Merged
merged 8 commits into from
Jun 16, 2022

Conversation

Zeroto521
Copy link
Member

@Zeroto521 Zeroto521 commented Jun 15, 2022

PR Description

Please describe the changes proposed in the pull request:

  1. hide inner methods
    image
  2. fix 'changed in version' section
    image

This PR resolves #1112.

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>.
  1. If you're not on the contributors list, add yourself to AUTHORS.md.
  1. 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.

*old_feature_range,
*feature_range,
)

return df


def min_max_value(df: pd.DataFrame, jointly: bool) -> tuple:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

functions/init.py only imports min_max_scale.
But the docstring of inner methods would be rendered by mkdocs.
This behavior is quite different to sphinx.

@codecov
Copy link

codecov bot commented Jun 15, 2022

Codecov Report

Merging #1123 (71d58be) into dev (63c075e) will decrease coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##              dev    #1123      +/-   ##
==========================================
- Coverage   97.99%   97.96%   -0.04%     
==========================================
  Files          77       77              
  Lines        3198     3198              
==========================================
- Hits         3134     3133       -1     
- Misses         64       65       +1     

@ericmjl
Copy link
Member

ericmjl commented Jun 16, 2022

@samukweku please do the honors!

@samukweku samukweku merged commit a06778a into pyjanitor-devs:dev Jun 16, 2022
@Zeroto521 Zeroto521 deleted the min-max-doc branch June 16, 2022 02:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants