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

[Fix] fix docstring inline code #1641

Merged
merged 2 commits into from
Feb 14, 2023
Merged

[Fix] fix docstring inline code #1641

merged 2 commits into from
Feb 14, 2023

Conversation

Z-Fran
Copy link
Collaborator

@Z-Fran Z-Fran commented Feb 14, 2023

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

fix wrong inline code format

Modification

Please briefly describe what modification is made in this PR.

Who can help? @ them here!

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

Before PR:

  • I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
  • Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
  • Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
  • New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects.
  • CLA has been signed and all committers have signed the CLA in this PR.

@Z-Fran Z-Fran requested a review from zengyh1900 February 14, 2023 04:14
@Z-Fran Z-Fran self-assigned this Feb 14, 2023
@codecov
Copy link

codecov bot commented Feb 14, 2023

Codecov Report

Base: 88.98% // Head: 88.98% // No change to project coverage 👍

Coverage data is based on head (cf37278) compared to base (fa8ab5d).
Patch has no changes to coverable lines.

❗ Current head cf37278 differs from pull request most recent head 8cad739. Consider uploading reports for the commit 8cad739 to get more accurate results

Additional details and impacted files
@@           Coverage Diff            @@
##           dev-1.x    #1641   +/-   ##
========================================
  Coverage    88.98%   88.98%           
========================================
  Files          400      400           
  Lines        26079    26079           
  Branches      4043     4043           
========================================
  Hits         23206    23206           
  Misses        1974     1974           
  Partials       899      899           
Flag Coverage Δ
unittests 88.98% <ø> (ø)

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

Impacted Files Coverage Δ
mmedit/datasets/singan_dataset.py 100.00% <ø> (ø)
mmedit/engine/hooks/iter_time_hook.py 100.00% <ø> (ø)
mmedit/engine/hooks/visualization_hook.py 91.52% <ø> (ø)
...t/engine/optimizers/multi_optimizer_constructor.py 90.47% <ø> (ø)
...t/engine/optimizers/pggan_optimizer_constructor.py 100.00% <ø> (ø)
.../engine/optimizers/singan_optimizer_constructor.py 92.85% <ø> (ø)
mmedit/engine/runner/log_processor.py 84.50% <ø> (ø)
mmedit/evaluation/evaluator.py 98.21% <ø> (ø)
mmedit/models/base_models/base_conditional_gan.py 100.00% <ø> (ø)
mmedit/models/base_models/base_gan.py 93.88% <ø> (ø)
... and 11 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@zengyh1900 zengyh1900 left a comment

Choose a reason for hiding this comment

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

lgtm.

@zengyh1900 zengyh1900 merged commit 4f6afac into dev-1.x Feb 14, 2023
@zengyh1900 zengyh1900 deleted the zjd/fix-readthedoc branch February 14, 2023 05:30
@Z-Fran Z-Fran mentioned this pull request Mar 2, 2023
7 tasks
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