Extend dev.deprecated to decorate classes and improve message

[DanielYang59]

Summary

• Extend dev.deprecated to be able to decorate classes. @esoteric-ephemera
• Improve deprecation message formatting (potentially breaking?), as pointed out by @janosh in Update VASP input sets for atomate2 compatibility materialsproject/pymatgen#3835 (comment)

[coderabbitai]

Walkthrough

The recent updates focus on enhancing functionality in monty/dev.py by improving GitHub repository URL handling, refining message crafting based on deadlines, and introducing class-level deprecation with new decorators. The test suite in tests/test_dev.py now includes a test case for class deprecation to ensure proper warning triggers.

Changes

File(s)	Change Summary
monty/dev.py	Added import inspect, updated GitHub repository URL handling, refined message crafting based on deadlines, renamed and added decorators.
tests/test_dev.py	Added test_deprecated_class test case, introduced TestClassOld and TestClassNew for deprecation testing.

---

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between eaa6c90 and 37fdad7.

Files selected for processing (1)

• monty/dev.py (3 hunks)

Files skipped from review due to trivial changes (1)

• monty/dev.py

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[DanielYang59]

@shyuep Can I have this reviewed please?

[DanielYang59]

Thanks!