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

[INF] Update mkdocstrings version to 0.19.0 #1138

Merged
merged 7 commits into from
Aug 10, 2022

Conversation

Zeroto521
Copy link
Member

@Zeroto521 Zeroto521 commented Aug 6, 2022

PR Description

Please describe the changes proposed in the pull request:

Part of #1133.

When I removed this line (cfeaad7). the doc-preview ci still failed.
Due to mkdocstring which stays in a lower version.
So it is time to update it.

       - name: Build docs
         run: |
           conda activate pyjanitor-dev
-          python -m ipykernel install --user --name pyjanitor-dev
           pip install -e .
           mkdocs build

This PR is related to #1133 (comment).

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.

@Zeroto521 Zeroto521 marked this pull request as ready for review August 6, 2022 08:30
@Zeroto521 Zeroto521 mentioned this pull request Aug 6, 2022
3 tasks
@codecov
Copy link

codecov bot commented Aug 6, 2022

Codecov Report

Merging #1138 (f55e0ed) into dev (cadd12f) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev    #1138      +/-   ##
==========================================
- Coverage   97.34%   97.31%   -0.04%     
==========================================
  Files          77       77              
  Lines        3240     3240              
==========================================
- Hits         3154     3153       -1     
- Misses         86       87       +1     

environment-dev.yml Outdated Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
@@ -14,6 +14,7 @@
- [ENH] Add `names_expand` and `index_expand` parameters to `pivot_wider` for exposing missing categoricals. Issue #1108 @samukweku
- [ENH] Add fix for slicing error when selecting columns in `pivot_wider`. Issue #1134 @samukweku
- [ENH] `dropna` parameter added to `pivot_longer`. Issue #1132 @samukweku
- [INF] Update `mkdocstrings` version and to fit its new coming features. PR #1138 @Zeroto521
Copy link
Member

Choose a reason for hiding this comment

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

Oooh, this is exciting! What new features are coming?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sine 0.19 mkdocstrings have to set a handler. This is a breaking changing.

But good for us, we can link to sphinx doc easily. https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories

@Zeroto521
Copy link
Member Author

softmax tests failing is fixed via #1139

@Zeroto521 Zeroto521 requested a review from ericmjl August 8, 2022 01:30
Copy link
Member

@ericmjl ericmjl left a comment

Choose a reason for hiding this comment

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

Approving! I am also going to take the liberty of merging, because the change is not in core code and is very small.

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.

None yet

2 participants