Skip to content

doc & test: Add documentation and update testing standards - #8

Merged
sbillinge merged 2 commits into
diffpy:mainfrom
cadenmyers13:structure-tests-and-docs
Oct 27, 2026
Merged

sbillinge merged 2 commits into
diffpy:mainfrom
cadenmyers13:structure-tests-and-docs

Conversation

@cadenmyers13

Copy link
Copy Markdown
Contributor

No description provided.

cadenmyers13 and others added 2 commits October 26, 2026 13:37
…lasses

Turn the test_objcrystparset.py TestCase classes into module-level
functions with snake_case names, move makeC60/makeLaMnO3 into fixtures
in conftest.py, and hoist imports to module scope. Test bodies and
assertions are unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add migrating-from-srfit.rst (every renamed function, attribute and
argument) and making-a-structure-adapter.rst, port srfit's npintensity
examples to the cmistructure names, replace the README placeholder
description, fix the README CLI name, and remove the scikit-package
template pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cadenmyers13

Copy link
Copy Markdown
Contributor Author

@sbillinge ready for review

@codecov

codecov Bot commented Oct 26, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 94.87179% with 20 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.37%. Comparing base (70b55b6) to head (a0c7f8b).
⚠️ Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
tests/test_objcrystparset.py 93.84% 20 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main       #8      +/-   ##
==========================================
+ Coverage   94.57%   95.37%   +0.80%     
==========================================
  Files           5        5              
  Lines         645      627      -18     
==========================================
- Hits          610      598      -12     
+ Misses         35       29       -6     
Files with missing lines Coverage Δ
tests/conftest.py 90.72% <100.00%> (+10.72%) ⬆️
tests/test_diffpyparset.py 100.00% <100.00%> (ø)
tests/test_sgconstraints.py 100.00% <100.00%> (ø)
tests/test_objcrystparset.py 93.92% <93.84%> (+1.06%) ⬆️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sbillinge
sbillinge merged commit c9277d7 into diffpy:main Oct 27, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants