Repository navigation
feat(scoring): document ConstraintWeight and export it at the crate roots - #215
Merged
Merged
Conversation
…oots ConstraintWeight bounds the weight of every public penalize and reward but was #[doc(hidden)], so those methods named a trait their documentation did not show. It is now documented: what score and is_hard mean, every implementing family (built-in scores, FixedWeight, closures, HardWeight), and a doctest implementing it for a custom weight scored through penalize. It is exported beside FixedWeight and HardWeight at the scoring and facade roots, and the wireframes list it. Closes #214.
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 #214. Base
main@93897e63, one commit47b006f0.ConstraintWeightloses#[doc(hidden)]; trait and method docs coverscore/is_hardand every implementing family; a doctest implements it for a custom weight and scores throughpenalize. Exported besideFixedWeight/HardWeightat the scoring and facade roots; wireframes updated; public API snapshot blessed. Verified:trait.ConstraintWeight.htmlrenders in bothsolverforge_scoring::streamandsolverforge.Gate (fmt, clippy, doc-names file-length facade-reachability public-api deps, rustdoc, examples, workspace all-feature tests, doctests): EXIT 0, 1590 passed, 0 failed, 71 result lines.