Skip to content

Conversation

@breyed
Copy link
Contributor

@breyed breyed commented Aug 31, 2018

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.

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.
@rpetrusha
Copy link

Thanks, @breyed. I've created issue dotnet/docs#7544 to track this issue, and added it to the community contributors' project.

@rpetrusha rpetrusha added ✨ 1st-time dotnet-api-docs contributor! Indicates PRs from new contributors to the dotnet-api-docs repository and removed ✨ 1st-time dotnet-api-docs contributor! Indicates PRs from new contributors to the dotnet-api-docs repository labels Sep 6, 2018
Copy link

@rpetrusha rpetrusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for suggesting the links to the Dataflow conceptual documentation, @breyed, and for adding a link to the BufferBlock<T> class. Since I've created #dotnet/docs#7544 to track this issue, I'll merge and close your PR now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants