More Subscriber and LogSubscriber doc uniformity [ci skip] #48088
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
attach_to was previously [improved][1] to allow defining methods after attaching instead of having to attach after all methods have been defined. The docs for Subscriber were [updated][2], but LogSubscriber docs were not. This commit copies the attach_to doc changes from Subscriber to LogSubscriber. In addition, there are other improvements to linking and applying the monospace formatting that were present in one of Subscriber or LogSubscriber and are now applied to both. The final change is updating the description of how flush_all! is used, because its usage has [changed][3] since this doc was written. [1]: 3408857 [2]: 25b3f73 [3]: 378464a
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.
Motivation / Background
attach_to was previously improved to allow defining methods after attaching instead of having to attach after all methods have been defined. The docs for Subscriber were updated, but LogSubscriber docs were not.
Detail
This commit copies the attach_to doc changes from Subscriber to LogSubscriber. In addition, there are other improvements to linking and applying the monospace formatting that were present in one of Subscriber or LogSubscriber and are now applied to both. The final change is updating the description of how flush_all! is used, because its usage has changed since this doc was written.
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number][ ] Tests are added or updated if you fix a bug or add a feature.[ ] CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.