Skip to content

[Docs] update readme according to standard#742

Merged
gaotongxiao merged 5 commits intoopen-mmlab:mainfrom
Harold-lkk:config-readme-standard
Jan 25, 2022
Merged

[Docs] update readme according to standard#742
gaotongxiao merged 5 commits intoopen-mmlab:mainfrom
Harold-lkk:config-readme-standard

Conversation

@Harold-lkk
Copy link
Copy Markdown
Collaborator

@Harold-lkk Harold-lkk commented Jan 19, 2022

Motivation

Update the config according to OpemMMLab's form-standard

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 19, 2022

Codecov Report

Merging #742 (f145a84) into main (8248802) will decrease coverage by 0.08%.
The diff coverage is n/a.

❗ Current head f145a84 differs from pull request most recent head 6bdba70. Consider uploading reports for the commit 6bdba70 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             main     #742      +/-   ##
==========================================
- Coverage   84.59%   84.51%   -0.09%     
==========================================
  Files         164      164              
  Lines       10642    10642              
  Branches     1618     1618              
==========================================
- Hits         9003     8994       -9     
- Misses       1295     1303       +8     
- Partials      344      345       +1     
Flag Coverage Δ
unittests 84.51% <ø> (-0.09%) ⬇️

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

Impacted Files Coverage Δ
mmocr/datasets/pipelines/transforms.py 82.56% <0.00%> (-1.43%) ⬇️

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 8248802...6bdba70. Read the comment docs.

Copy link
Copy Markdown
Collaborator

@gaotongxiao gaotongxiao left a comment

Choose a reason for hiding this comment

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

We need to wrap notes with

:::{note} 
:::

There are some other files where I didn't propose a suggestion snippet, but you need to check as well

@Harold-lkk Harold-lkk force-pushed the config-readme-standard branch from f3689ec to ed2e173 Compare January 25, 2022 09:58
@gaotongxiao gaotongxiao force-pushed the config-readme-standard branch from 04e790d to 2b30b85 Compare January 25, 2022 12:54
@gaotongxiao gaotongxiao force-pushed the config-readme-standard branch from 2b30b85 to 6bdba70 Compare January 25, 2022 12:54
@gaotongxiao gaotongxiao merged commit 976b976 into open-mmlab:main Jan 25, 2022
gaotongxiao pushed a commit to gaotongxiao/mmocr that referenced this pull request Jul 15, 2022
* config/readme standard

* add ABINet linking

* fix linking error, delete unused cite and adjust note sytle

* union note format

* Remove > before paper link when generating docs
gaotongxiao pushed a commit to gaotongxiao/mmocr that referenced this pull request Jul 15, 2022
* config/readme standard

* add ABINet linking

* fix linking error, delete unused cite and adjust note sytle

* union note format

* Remove > before paper link when generating docs
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.

2 participants