Tighten changelog wording: user voice for behaviour, Internal: for refactors#79
Merged
Merged
Conversation
Replace 'pure-string site rows' with 'sites whose species is given as a plain label', and 'rule lookups' with 'polyhedron rules' to match the user-guide language landed in #78. Cosmetic only — the GitHub release notes for v0.20.0 retain the original wording, but this keeps the in-repo changelog consistent for any future references.
There was a problem hiding this comment.
Pull request overview
Updates the v0.20.0 changelog wording around AtomStyle.visible behavior so it matches the terminology used in the user guide (PR #78), keeping in-repo documentation consistent with published guidance.
Changes:
- Clarifies that
AtomStyle.visibleapplies to sites whose species is provided as a plain label (string), notCompositionconstituents. - Replaces “rule lookups” phrasing with “polyhedron rules” to better match existing terminology.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Six entries reworded to lead with user-visible behaviour rather than internal API or implementation: - 0.19.0 species tuple line: 'fixed at construction and can no longer be mutated' instead of 'stored as a tuple' - 0.19.0 atom_data write/reassignment: compress two dense paragraphs into the user-facing rules (validation, key naming, reassignment-after-append, and when clear_2d_atom_data is needed) - 0.19.0 read-only mapping: replace the TypeError/AttributeError protocol matrix with the user-facing summary plus the canonical write-method names - 0.9.0 bond detection: drop MIC vs 27-image internals, keep the behavioural dispatch rule - 0.9.0 deduplication algorithm: collapse the four-step description to the behavioural summary with a cross-ref to scenes.rst Two entries that were pure refactors lacking the 'Internal:' tag have it added: - 0.10.1 BondSpec validation extraction (the user-visible colour validation fix is now its own bullet) - 0.7.1 _merge_expansions array-growth fix
bjmorgan
changed the title
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.
Summary
Two passes over the changelog to keep user-facing entries in user voice and label refactors as such for contributor scan-skipping.
User-facing changes reworded (5):
Internal: prefix added to unlabelled refactors (2):
The GitHub release notes for v0.20.0 retain their original wording; this is the in-repo source of truth for any future references.