Run the pinned example, rather than ignoring it - #83
Closed
pathscale wants to merge 1 commit into
Closed
Conversation
The example on `PartitionSet::pinned` was `ignore`, so it never compiled. It referenced `prices`, `batch` and `tick` without defining them, which is exactly why it could not run - and it is the only documentation the API has. An `ignore` example on a new public method is worse than none: it looks checked, and it rots silently against the very signature it documents. Made self-contained and executable - declares a partitioned table, inserts, then shows the pin-once-read-many shape the surrounding prose argues for.
Merged
Owner
Author
|
Superseded by #87, which carries this commit rebased onto master. |
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.
The example on
PartitionSet::pinnedwasignore, so it never compiled. Itreferenced
prices,batchandtickwithout defining them — which is why itcould not run, and it is the only documentation that method has.
An
ignoreexample on a new public method is worse than none: it reads aschecked, and it rots silently against the signature it documents.
cargo test --docreported it as an ignored test onbeta.16.Now self-contained and executable — declares a partitioned table, inserts,
and shows the pin-once-read-many shape the surrounding prose argues for.
Found while auditing what shipped in
1.0.0-beta.16.