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

[Refactor] Use mdformat instead of markdownlint to format markdown. #844

Merged
merged 4 commits into from
Jun 2, 2022

Conversation

mzr1996
Copy link
Member

@mzr1996 mzr1996 commented May 18, 2022

Motivation

The markdownlint requires ruby which is not easy to install in many environments.

Modification

Use mdformat to replace markdownlint.

@mzr1996 mzr1996 requested a review from Ezra-Yu May 18, 2022 14:57
@codecov
Copy link

codecov bot commented May 18, 2022

Codecov Report

Merging #844 (2d0ab96) into dev (3e198e6) will increase coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev     #844      +/-   ##
==========================================
+ Coverage   86.75%   86.80%   +0.04%     
==========================================
  Files         130      130              
  Lines        8571     8571              
  Branches     1478     1478              
==========================================
+ Hits         7436     7440       +4     
+ Misses        911      909       -2     
+ Partials      224      222       -2     
Flag Coverage Δ
unittests 86.72% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mmcls/datasets/builder.py 87.83% <0.00%> (+4.05%) ⬆️
mmcls/utils/setup_env.py 100.00% <0.00%> (+4.54%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3e198e6...2d0ab96. Read the comment docs.

@mzr1996 mzr1996 force-pushed the update-commit-hook branch from a250433 to 02b0425 Compare June 1, 2022 10:37
@yingfhu
Copy link
Collaborator

yingfhu commented Jun 1, 2022

LGTM

Copy link
Collaborator

@Ezra-Yu Ezra-Yu left a comment

Choose a reason for hiding this comment

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

LGTM.

@mzr1996 mzr1996 merged commit 824fbcb into open-mmlab:dev Jun 2, 2022
mzr1996 added a commit to mzr1996/mmpretrain that referenced this pull request Nov 24, 2022
…pen-mmlab#844)

* [Refactor] Use mdformat instead of markdownlint to format markdown.

* Update unavailiable api links in tutorials

* Update CONTRIBUTING.md

* Use mdformat==0.7.9 to support Python 3.6
@mzr1996 mzr1996 deleted the update-commit-hook branch December 7, 2022 02:11
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