Repository navigation
docs(scoring): document ConstraintSet::constraint_metadata_entries - #213
Merged
Merged
Conversation
constraint_metadata_entries is a required method of the public ConstraintSet trait but was #[doc(hidden)], so an implementor had to write a method the documentation did not show. It cannot get a default, since tuples and chains build their entries from their members' raw entries and constraint_metadata deduplicates the result. It is now documented with that contract in the trait, the scoring wireframe and docs/extend-scoring.md. Closes #212.
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.
Closes #212. Base
main@40e95abc, one commit93897e63.Removes
#[doc(hidden)]from the requiredConstraintSet::constraint_metadata_entriesand documents its contract (one entry per named constraint in authored order, duplicates kept;constraint_metadatadeduplicates) in the trait, the scoring wireframe anddocs/extend-scoring.md. A default is impossible: tuples and chains compose their members' raw entries. Verified: the method now renders intrait.ConstraintSet.htmland appears inpublic-api.txt.Gate (fmt, clippy, doc-names file-length facade-reachability public-api deps, rustdoc, examples, workspace all-feature tests, doctests): EXIT 0, 1588 passed, 0 failed, 71 result lines.