Repository navigation
fix(macros): document or hide every generated public item - #236
Merged
Merged
Conversation
The planning macros emitted public items without docs, so a user crate that enables missing_docs got warnings it could not fix, pointing at the attribute. Internal plumbing (descriptor, entity_count, entity_descriptor, problem_fact_descriptor and __SOLVERFORGE_LIST_VARIABLE_COUNT) is now #[doc(hidden)] like the macros' other hidden accessors, and the collection source methods, the generated <Solution>ConstraintStreams trait and its methods carry generated docs. The generated_items_documented test denies missing_docs over a planning model that re-exports the stream trait; it fails without either half of the change. The macros WIREFRAME records which generated items are hidden. Closes #235
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 #235. Local gate on the branch tip: make ci-local and make lint passed (1715 tests, 0 failed, 116 result lines; clippy --all-targets --all-features -D warnings; public API, facade reachability, doc names, file length, deps). New test generated_items_documented fails without either half of the fix.