Skip to content

docs: refresh project metadata and references#1027

Open
njzjz-bot wants to merge 2 commits into
deepmodeling:masterfrom
njzjz-bot:fix/issue-1003
Open

docs: refresh project metadata and references#1027
njzjz-bot wants to merge 2 commits into
deepmodeling:masterfrom
njzjz-bot:fix/issue-1003

Conversation

@njzjz-bot

@njzjz-bot njzjz-bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Fixes #1003.

Correct stale dpdata names, derive Sphinx version metadata from the installed package, and fix the BondOrderSystem sanitizer path.

Tests: python -m py_compile docs/conf.py plus package-version assertion.

Why existing tests missed it: Templates and documentation metadata are not exercised by the parser/unit-test suite.

Coding agent: Codex
Codex version: codex-cli 0.144.4
Model: gpt-5.6-sol
Reasoning effort: xhigh

Summary by CodeRabbit

  • Documentation
    • Documentation version information now stays synchronized with the installed package version.
    • Corrected the referenced RDKit sanitizer path in the BondOrderSystem documentation.
    • Updated issue template guidance to consistently reference dpdata.

Make issue templates consistently name dpdata, derive Sphinx version metadata from the installed package, and point BondOrderSystem docs to the real sanitizer path. These stale strings were not executable code and therefore were outside the existing test suite.

Coding-Agent: Codex
Codex-Version: codex-cli 0.144.4
Model: gpt-5.6-sol
Reasoning-Effort: xhigh
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation dpdata labels Jul 16, 2026
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ab3138ed-eb3e-4f77-a3e0-c457d29db833

📥 Commits

Reviewing files that changed from the base of the PR and between 0416b54 and b09d5a1.

📒 Files selected for processing (4)
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • docs/conf.py
  • docs/systems/bond_order_system.md

📝 Walkthrough

Walkthrough

The changes correct stale dpdata references in issue templates and BondOrderSystem documentation, and derive Sphinx version metadata from the package’s runtime version.

Changes

Repository metadata and documentation

Layer / File(s) Summary
Runtime-derived documentation metadata
docs/conf.py
Sphinx release now uses dpdata.__version__, while version is derived from its first two components.
Issue-template and API reference corrections
.github/ISSUE_TEMPLATE/*.yml, docs/systems/bond_order_system.md
Issue templates now reference dpdata, and the BondOrderSystem documentation points to dpdata.formats.rdkit.sanitize.Sanitizer.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the PR's main focus on refreshing docs metadata and references.
Linked Issues check ✅ Passed The changes match issue #1003 by fixing stale template text, version metadata, and the sanitizer doc path.
Out of Scope Changes check ✅ Passed All edits align with the linked issue scope and PR objectives; no unrelated changes are evident.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codspeed-hq

codspeed-hq Bot commented Jul 16, 2026

Copy link
Copy Markdown

Merging this PR will degrade performance by 11.91%

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

❌ 1 regressed benchmark
✅ 1 untouched benchmark

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
WallTime test_import 11.8 ms 13.3 ms -11.91%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing njzjz-bot:fix/issue-1003 (b09d5a1) with master (0416b54)

Open in CodSpeed

@codecov

codecov Bot commented Jul 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.87%. Comparing base (0416b54) to head (b09d5a1).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1027   +/-   ##
=======================================
  Coverage   86.87%   86.87%           
=======================================
  Files          89       89           
  Lines        8266     8266           
=======================================
  Hits         7181     7181           
  Misses       1085     1085           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation dpdata size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Code scan] Repository templates and docs contain stale dpdata metadata

1 participant