Code clean-up and documentation refresh#201
Merged
Merged
Conversation
AndrewSazonov
added
the
[scope] maintenance
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #201 +/- ##
===========================================
+ Coverage 90.22% 90.30% +0.07%
===========================================
Files 271 274 +3
Lines 23273 23380 +107
Branches 2718 2727 +9
===========================================
+ Hits 20999 21113 +114
+ Misses 1707 1693 -14
- Partials 567 574 +7
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This update refreshes the EasyDiffraction documentation and tidies the library's internals. The getting-started and analysis user guides have been corrected to match the current API, and the single-crystal example tutorials now follow a consistent
sc-naming scheme, making the examples easier to find and follow. Under the hood, some unused code was removed and a small amount of duplicated logic consolidated — with no change to how the library works or to any results it produces.