subscriber: improve docs on Layer composition
#566
Merged
Conversation
This file contains 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
This commit adds a new section to the `Layer` docs on how `Layer`s and `Subscriber`s are composed. Additionally, it updates the docs to prefer the use of `SubscriberExt::with` over `Layer::with_subscriber`. Signed-off-by: Eliza Weisman <[email protected]>
hawkw
force-pushed
the
eliza/subscriber-docs
branch
from
99d7cf8 to
5b6121e
Compare
davidbarsky
approved these changes
Feb 4, 2020
Signed-off-by: Eliza Weisman <[email protected]>
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.
Depends on #564
This commit adds a new section to the
Layerdocs on howLayers andSubscribers are composed. Additionally, it updates the docs to preferthe use of
SubscriberExt::withoverLayer::with_subscriber.Additionally, I've fixed how
SubscriberExt::withis implemented, sothat
Layers may usewith_subscriberas a callback for composition.Closes #452
Closes #505 (IMO)