Skip to content

conf.py docs fix #104

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

Merged
merged 17 commits into from
Apr 3, 2025
Merged

conf.py docs fix #104

merged 17 commits into from
Apr 3, 2025

Conversation

orionarcher
Copy link
Collaborator

Summary

Include a summary of major changes in bullet points:

  • Feature 1
  • Fix 1

Checklist

Work-in-progress pull requests are encouraged, but please enable the draft status on your PR.

Before a pull request can be merged, the following items must be checked:

  • Doc strings have been added in the Numpy docstring format.
    Run ruff on your code.
  • Tests have been added for any new functionality or bug fixes.
  • All linting and tests pass.

Note that the CI system will run all the above checks. But it will be much more
efficient if you already fix most errors prior to submitting the PR. It is highly
recommended that you use the pre-commit hook provided in the repository. Simply run
pre-commit install and a check will be run prior to allowing commits.

@cla-bot cla-bot bot added the cla-signed Contributor license agreement signed label Apr 3, 2025
Copy link

codecov bot commented Apr 3, 2025

Codecov Report

Attention: Patch coverage is 65.90909% with 15 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
torch_sim/io.py 37.50% 10 Missing ⚠️
torch_sim/trajectory.py 68.75% 5 Missing ⚠️
Flag Coverage Δ
core 64.42% <65.90%> (+0.55%) ⬆️
elastic 26.49% <6.81%> (-0.09%) ⬇️
mace 17.56% <6.81%> (-0.53%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
torch_sim/autobatching.py 88.51% <100.00%> (ø)
torch_sim/state.py 85.77% <ø> (ø)
torch_sim/trajectory.py 87.00% <68.75%> (-0.32%) ⬇️
torch_sim/io.py 84.95% <37.50%> (+2.98%) ⬆️

... and 6 files with indirect coverage changes

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

@orionarcher orionarcher merged commit efeab5b into main Apr 3, 2025
72 checks passed
@orionarcher orionarcher deleted the fix-docs-conf branch April 3, 2025 14:52
orionarcher added a commit that referenced this pull request Apr 3, 2025
* plot speedup

* change import line

* conf.py docs fix

* restyle TorchSim -> torch-sim

* small typo fix

* tweak err messages

* small trajectory fix and ignore unbatched in codecov

* remove seemingly unneeded Structure/Atoms/PhonopyAtoms stubs in torch_sim/io.py

* set coverage target

* fix toml

* multi line string

* tweak doc strings

* switch away from .png

* move speedup up in readme

* fix broken links and set threshold differently

* docs fix

* delete codevoc threshhold attempt

---------

Co-authored-by: Janosh Riebesell <janosh.riebesell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Contributor license agreement signed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants