-
Notifications
You must be signed in to change notification settings - Fork 59
docs: add the citation #555
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
Conversation
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@ustc.edu.cn>
for more information, see https://pre-commit.ci
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## master #555 +/- ##
===========================================
- Coverage 60.40% 47.60% -12.81%
===========================================
Files 39 39
Lines 3905 3905
===========================================
- Hits 2359 1859 -500
- Misses 1546 2046 +500 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
📝 WalkthroughWalkthroughDocumentation updates across two files: a Credits section with citation information is added to README.md and a bibliographic entry for a DPDispatcher paper is added to doc/index.rst. Both represent pure documentation changes with no functional code modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
doc/index.rst (1)
13-20: Add DOI reference to match README documentation.The citation in doc/index.rst is incomplete compared to README.md—it omits the DOI link and citation badge. For consistency and to provide complete bibliographic information across all documentation entry points, add the DOI reference:
- Fengbo Yuan, Zhaohan Ding, Yun-Pei Liu, Kai Cao, Jiahao Fan, Cao - Thang Nguyen, Yuzhi Zhang, Haidi Wang, Yixiao Chen, Jiameng Huang, - Tongqi Wen, Mingkang Liu, Yifan Li, Yong-Bin Zhuang, Hao Yu, Ping - Tuo, Yaotang Zhang, Yibo Wang, Linfeng Zhang, Han Wang, Jinzhe Zeng, - DPDispatcher: Scalable HPC Task Scheduling for AI-Driven Science, *J. - Chem. Inf. Model.*, 2025. + Fengbo Yuan, Zhaohan Ding, Yun-Pei Liu, Kai Cao, Jiahao Fan, Cao + Thang Nguyen, Yuzhi Zhang, Haidi Wang, Yixiao Chen, Jiameng Huang, + Tongqi Wen, Mingkang Liu, Yifan Li, Yong-Bin Zhuang, Hao Yu, Ping + Tuo, Yaotang Zhang, Yibo Wang, Linfeng Zhang, Han Wang, Jinzhe Zeng, + DPDispatcher: Scalable HPC Task Scheduling for AI-Driven Science, *J. + Chem. Inf. Model.*, 2025, DOI: `10.1021/acs.jcim.5c02081 <https://doi.org/10.1021/acs.jcim.5c02081>`_.Consider also adding the DP-GEN origin note from README.md to provide fuller context in the documentation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(1 hunks)doc/index.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
doc/**/*.{rst,md}
📄 CodeRabbit inference engine (AGENTS.md)
Write documentation for Sphinx, using reStructuredText or MyST Markdown in doc/
Files:
doc/index.rst
Signed-off-by: Jinzhe Zeng jinzhe.zeng@ustc.edu.cn
Summary by CodeRabbit