Improve parameter discoverability, constraint semantics, and CIF output#172
Merged
Conversation
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## develop #172 +/- ##
===========================================
+ Coverage 86.29% 86.32% +0.02%
===========================================
Files 158 158
Lines 12138 12179 +41
Branches 1394 1400 +6
===========================================
+ Hits 10475 10513 +38
- Misses 1154 1155 +1
- Partials 509 511 +2
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
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 PR improves API discoverability and parameter inspection across the project by adding help() coverage for display and summary facades, hiding large loop-backed categories from parameter summary views, and adding a Quick Reference page for common workflows.
It also clarifies fitting semantics by renaming constraint state flags to distinguish user-defined constraints from symmetry-imposed constraints, aligning fittable displays with actual refinability, and fixing CIF/identity issues so loop-backed items resolve the correct datablock path and empty category fragments do not introduce blank sections in show_as_cif() output.