Link to overview #486
Merged
Link to overview #486
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
The docs page for the Dataflow namespace links to the dataflow overview, but none of the class pages do. You can get from a class page to the overview in two steps, but you'd have to be lucky enough to guess that you should click on the namespace first. Until you do, you're left wondering what makes a BufferBlock different from an array, a queue, or any other "buffer for storing data". The PR shows one way of making the overview more discoverable. The PR should be updated as needed to become the best way to provide the link and then expanded to cover all dataflow classes.
|
Thanks, @breyed. I've created issue dotnet/docs#7544 to track this issue, and added it to the community contributors' project. |
rpetrusha
added
✨ 1st-time dotnet-api-docs contributor!
22 tasks
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.
The docs page for the Dataflow namespace links to the dataflow overview, but none of the class pages do. You can get from a class page to the overview in two steps, but you'd have to be lucky enough to guess that you should click on the namespace first. Until you do, you're left wondering what makes a BufferBlock different from an array, a queue, or any other "buffer for storing data".
The PR shows one way of making the overview more discoverable. The PR should be updated as needed to become the best way to provide the link and then expanded to cover all dataflow classes.