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

[Doc] Fix invalid symbols in docstring #1466

Merged
merged 4 commits into from
Nov 8, 2021
Merged

Conversation

MeowZheng
Copy link
Collaborator

@MeowZheng MeowZheng commented Nov 7, 2021

Motivation

There exits some invalid symbols in docstring, and raise exception when compiling documents with latex

Modification

  1. revise the docstring in mmcv/ops/correlation.py
  2. revise the docstring in mmcv/ops/group_points.py
  3. revise the docstring in mmcv/ops/points_sampler.py

BC-breaking (Optional)

No

Use cases (Optional)

No

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, like MMDet or MMCls.
  • CLA has been signed and all committers have signed the CLA in this PR.

@ZwwWayne ZwwWayne merged commit 792473c into open-mmlab:master Nov 8, 2021
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