Skip to content

[DOC] MkDocs Utils Part 1 #912

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 9 commits into from
Sep 7, 2021
Merged

[DOC] MkDocs Utils Part 1 #912

merged 9 commits into from
Sep 7, 2021

Conversation

loganthomas
Copy link
Member

This PR is for docstring changes to utils submodule. Since utils has 74 functions, each PR will contain ~5 functions for review.

  • check()
  • _strip_underscores()
  • import_message()
  • idempotent()
  • deprecated_alias()

Zeroto521 and others added 9 commits September 4, 2021 10:00
)

* [INF] simplify a bit linting

There is two similar linting CIs (pre-commit and code-checks) but also have tiny differences.

We should use one of them as the standard, not both.

* Update CHANGELOG.md

* should be `--config` not `-c`

`-c` = `--code TEXT`, Format the code passed in as a string.

* remove nbstripout

keep the same with the old code-checks.yml

* lint via pre-commit

* Update CHANGELOG.md

Co-authored-by: Eric Ma <[email protected]>
@loganthomas loganthomas requested a review from ericmjl September 5, 2021 14:24
@codecov
Copy link

codecov bot commented Sep 5, 2021

Codecov Report

Merging #912 (151f36b) into mkdocs (8bc6bd0) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           mkdocs     #912   +/-   ##
=======================================
  Coverage   95.66%   95.66%           
=======================================
  Files          19       19           
  Lines        2448     2448           
=======================================
  Hits         2342     2342           
  Misses        106      106           

@loganthomas loganthomas changed the title [DOC] MkDocs Utils [DOC] MkDocs Utils Part 1 Sep 5, 2021
@ericmjl
Copy link
Member

ericmjl commented Sep 6, 2021

@nvamsikrishna05 or @samukweku - one more review from either of you, and then please feel free to do the honors when you're done reviewing!

@loganthomas loganthomas self-assigned this Sep 6, 2021
@nvamsikrishna05 nvamsikrishna05 merged commit 544dbdc into pyjanitor-devs:mkdocs Sep 7, 2021
@loganthomas loganthomas deleted the mkdocs-utils branch September 11, 2021 02:09
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.

4 participants