dotnet / dotnet/dotnet-api-docs

System.IO.Pipelines is seriously underdocumented

Open
#1,749 2 comments 1 reaction 0 assignees View on GitHub
area-System.IO.Pipelines dotnet-api/prod Pri2 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

Given that there's movement towards exposing a second implementation of IBufferWriter within the timeframe of .NET Core 3.0, we should probably provide documentation on Use-Case and differentiation with others specifically for PipeWriter.

Currently all framework spices redirect to .NET Platform Extensions, where no exposed type is really documented besides some sparse summaries.

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: 7f22281d-14f2-973d-7f47-74d00c35e925
* Version Independent ID: 4bb0d319-3f73-2acb-4044-a6b85840e0e4
* Content: [PipeWriter Class (System.IO.Pipelines)](https://docs.microsoft.com/en-us/dotnet/api/system.io.pipelines.pipewriter?view=dotnet-plat-ext-2.1)
* Content Source: [xml/System.IO.Pipelines/PipeWriter.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.IO.Pipelines/PipeWriter.xml)
* Product: **dotnet-api**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.