Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs for PipeReader.TryRead #52237

Merged
merged 5 commits into from
Oct 21, 2021
Merged

Update docs for PipeReader.TryRead #52237

merged 5 commits into from
Oct 21, 2021

Commits on May 4, 2021

  1. Update docs for PipeReader.TryRead 

    As per dotnet#30161 (comment), add some documentation to `PipeReader.TryRead` to better document some unclear behavior.

The unclear behavior technically resides in the `StreamPipeReader.TryRead` implementation, which is internal, so I added this as a `<remark>` to the public `PipeReader.TryRead` method instead.
    @waf
    waf committed May 4, 2021
    Configuration menu
    Copy the full SHA
    855ff2e View commit details
    Browse the repository at this point in the history

Commits on Jun 29, 2021

  1. remove doc reference to internal StreamPipeReader 

    The StreamPipeReader <see .. /> reference is an internal type, so it should not be mentioned in the public documentation.
    @waf
    waf committed Jun 29, 2021
    Configuration menu
    Copy the full SHA
    8ca456b View commit details
    Browse the repository at this point in the history

Commits on Oct 9, 2021

  1. Merge branch 'main' into update-docs-for-streampipereader-tryread

    @jeffhandley
    jeffhandley committed Oct 9, 2021
    Configuration menu
    Copy the full SHA
    ecc247c View commit details
    Browse the repository at this point in the history

  2. Format remarks as markdown and use !IMPORTANT

    @jeffhandley
    jeffhandley committed Oct 9, 2021
    Configuration menu
    Copy the full SHA
    e61099b View commit details
    Browse the repository at this point in the history

  3. Merge branch 'main' into update-docs-for-streampipereader-tryread

    @jeffhandley
    jeffhandley committed Oct 9, 2021
    Configuration menu
    Copy the full SHA
    8ac322c View commit details
    Browse the repository at this point in the history