docs(chart,tuner): correct docstrings after all-cores and axis-keep - #698
Merged
Merged
Conversation
An audit of the comments added by the all-cores chart history and the tuner's axis-keep change found ten that no longer matched the code: - the corner-caption count was described as the same test as pane_admits_record; it is the owner-pane gate plus a set wider than the owner, not the per-record contains check; - None on the admitted core set was described as the state of every panel; a chart load now stores Some even with the flag off, and None means an unpublished set, a cleared target or the frozen Trade window; - the report-axis observer's Returns line said every in-flight read identity retires, contradicting the joint-suggestion exception in the same docstring, and the kept search was said to finish on the axis it started on, which holds only once the scan has materialized its sample. Comment and docstring lines only; no code changes.
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.
What & why
An audit of the comments added by #696 and #697 found ten that no longer matched the code — most notably the corner-caption count described as the same test as
pane_admits_record(it is the owner-pane gate plus a set wider than the owner), and the report-axis observer's docstring contradicting its own joint-suggestion exception.Comment and docstring lines only: every changed line is a
//comment or blank.How to verify
cargo fmt --all -- --checkandcargo test -p moon-ui-gpui --test theme_contract(360 pass) — the static contracts read sources as text, comments included.