-
Notifications
You must be signed in to change notification settings - Fork 169
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
[INF] Update mkdocstrings
version to 0.19.0
#1138
Conversation
Codecov Report
@@ 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 |
@@ -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 |
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.
Oooh, this is exciting! What new features are coming?
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.
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
|
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.
Approving! I am also going to take the liberty of merging, because the change is not in core code and is very small.
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:
<your_username>
:dev
, but rather from<your_username>
:<feature-branch_name>
.AUTHORS.md
.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.