Repository navigation
docs: resolve the five hidden public traits - #217
Merged
Merged
Conversation
UnassignedEntity bounds the public UniConstraintStream::unassigned but was #[doc(hidden)]. It is now documented: what #[planning_entity] implements for an entity with one Option planning variable, and a doctest implementing it by hand for a sentinel-valued entity filtered through unassigned().
ExplainRow is re-exported from the documented stream::relational::operator extension point and bounds explanation on terminals, but was #[doc(hidden)]. It is now documented: when terminals call it, what each view family appends, and that a custom operator implements it for its View to make its matches explainable.
…hain OperatorScorerSet bounds public SharedOperatorTerminal and SharedOperatorBuilder methods, and OperatorScorer and ScorerChain appear in the terminal types they return, but all three were #[doc(hidden)] and the trait was not re-exported. The trait moves to operator_scorer/set.rs, keeping operator_scorer.rs under the file-length limit, is re-exported beside them, and all three are documented: what a scorer set does per notification, each implementation, and every method.
stream::projected::Source is re-exported and bounds the projected stream types, and its methods take RowCoordinate and RowOwner, but all three were #[doc(hidden)]. They are now documented: what a source produces and how the operator tree re-reads it per notification, every method, and the row identity fields and constructors.
ResourceMoveCursor carried #[doc(hidden)], which did nothing: the trait lives in a private module and is not re-exported, so code outside the crate cannot name it, and it is reachable only as the bound of the local-search cursor source behind local_search. The attribute is gone, the trait says so, every method is documented, and the provided next_owned_candidate_inspected_with_resources, which nothing called, is deleted. Closes #216.
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 #216. Base
main@47b006f0, five commits, one per trait:a1f59accUnassignedEntitydocumented, with a doctest implementing it by hand and filtering throughunassigned().48c25a0bExplainRowdocumented as the operator extension point's explanation contract.aebef6e3OperatorScorerSet(moved tooperator_scorer/set.rsfor the file-length limit, now re-exported),OperatorScorerandScorerChaindocumented; one trybuild diagnostic now printsOperatorScorerby its short name.892e1dc4projectedSource,RowCoordinateandRowOwnerdocumented.b2f02b55ResourceMoveCursor: the no-op#[doc(hidden)]removed (private module, not re-exported), methods documented, unused providednext_owned_candidate_inspected_with_resourcesdeleted.Each commit carries its own
public-api.txtdelta (2 + 18 + 16 lines).Gate (fmt, clippy, doc-names file-length facade-reachability public-api deps, rustdoc, examples, workspace all-feature tests, doctests): EXIT 0, 1592 passed, 0 failed, 71 result lines.