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

style: enable W rules #3793

Merged
merged 2 commits into from
May 18, 2024
Merged

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented May 17, 2024

Fix #3789.

Summary by CodeRabbit

  • Documentation

    • Corrected a minor formatting issue in the quick start guide for displaying a file path.
  • Chores

    • Added a new linting rule for warnings to improve code quality.
  • Tests

    • Improved regular expression handling in test cases by using raw string notation.

Fix deepmodeling#3789.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz changed the base branch from r2 to devel May 17, 2024 20:02
Copy link
Contributor

coderabbitai bot commented May 17, 2024

Walkthrough

The recent updates include minor adjustments to documentation, configuration, and test files. Specifically, a space character was removed from a file path in a Jupyter notebook, a new linting rule for warnings was added to the pyproject.toml configuration file, and a raw string prefix was added to a regular expression pattern in a test file to ensure proper handling.

Changes

Files Change Summary
doc/getting-started/quick_start.ipynb Removed a space character in the file path DeePMD-kit_Tutorial/00.data/training_data/type.raw.
pyproject.toml Added "W", # warning to the list of selected linting rules under [tool.ruff.lint].
source/tests/pt/model/test_fitting_net.py Added an r prefix to the regular expression pattern in the re.match function call.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@njzjz njzjz linked an issue May 17, 2024 that may be closed by this pull request
@njzjz njzjz requested a review from wanghan-iapcm May 17, 2024 20:07
@njzjz njzjz marked this pull request as ready for review May 17, 2024 20:07
Copy link

codecov bot commented May 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.58%. Comparing base (42724ce) to head (3d4f5f7).
Report is 136 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3793   +/-   ##
=======================================
  Coverage   82.58%   82.58%           
=======================================
  Files         515      515           
  Lines       48806    48806           
  Branches     2983     2984    +1     
=======================================
  Hits        40308    40308           
  Misses       7587     7587           
  Partials      911      911           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@njzjz njzjz changed the title Enable w rules style: enable W rules May 17, 2024
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue May 18, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 18, 2024
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue May 18, 2024
Merged via the queue into deepmodeling:devel with commit 81b5949 May 18, 2024
60 checks passed
@njzjz njzjz added this to the v2.2.11 milestone Jun 29, 2024
njzjz added a commit to njzjz/deepmd-kit that referenced this pull request Jul 2, 2024
Fix deepmodeling#3789.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

- **Documentation**
- Corrected a minor formatting issue in the quick start guide for
displaying a file path.

- **Chores**
  - Added a new linting rule for warnings to improve code quality.

- **Tests**
- Improved regular expression handling in test cases by using raw string
notation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 81b5949)
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz mentioned this pull request Jul 2, 2024
njzjz added a commit that referenced this pull request Jul 3, 2024
Fix #3789.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

- **Documentation**
- Corrected a minor formatting issue in the quick start guide for
displaying a file path.

- **Chores**
  - Added a new linting rule for warnings to improve code quality.

- **Tests**
- Improved regular expression handling in test cases by using raw string
notation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 81b5949)
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
Fix deepmodeling#3789.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
- Corrected a minor formatting issue in the quick start guide for
displaying a file path.

- **Chores**
  - Added a new linting rule for warnings to improve code quality.

- **Tests**
- Improved regular expression handling in test cases by using raw string
notation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DeprecationWarning: invalid escape sequence '\.'
2 participants