dotnet / dotnet/dotnet-api-docs

Clarify purpose of `BlockingCollection<T>.GetConsumingEnumerable` and relationship to `Take`

Abierto
#779 1 comentario 0 reacciones 0 asignados Ver en GitHub
.net/prod area-System.Collections Pri2 unspecified/svc untriaged
Lenguaje dominante
C#
Estrellas
950
Forks
1.7k
Merge medio
2 d 19 h
PR fusionados (30 d)
52

Descripción

I have two suggestions:
1. Add a "Remarks" section to `GetConsumingEnumerable()` that is identical to the remarks section for `GetConsumingEnumerable(CancellationToken)`. It contains several useful facts about how `GetConsumingEnumerable()` works. Putting it in the "Remarks" section for `GetConsumingEnumerable(CancellationToken)` isn't sufficient because people like me that don't care about cancellation are unlikely to look at `GetConsumingEnumerable(CancellationToken)`.
2. In the "Remarks" section for `Take`, mention that if you want to consume items in a loop, consider using `GetConsumingEnumerable` which is designed for this use case. I'm assuming that's the relationship between `Take` and `GetConsumingEnumerable`. It took some thinking on my part to infer this because it's not explicitly stated anywhere. You might also want to make a statement about `Take` in the "Remarks" section for `GetConsumingEnumerable`.

Adam Comella
Microsoft Corp.

---
#### Document Details

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

* ID: f8df56b2-d5da-8d38-ea9d-7f2fb50f877f
* Version Independent ID: f903165e-d4c7-939f-6679-413310730fe6
* Content: [BlockingCollection.GetConsumingEnumerable Method (System.Collections.Concurrent)](https://docs.microsoft.com/en-us/dotnet/api/system.collections.concurrent.blockingcollection-1.getconsumingenumerable?view=netframework-4.7.2#System_Collections_Concurrent_BlockingCollection_1_GetConsumingEnumerable)
* Content Source: [xml/System.Collections.Concurrent/BlockingCollection`1.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Collections.Concurrent/BlockingCollection`1.xml)
* Service: **unspecified**
* Product: **.net**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Abre xml/System.Collections.Concurrent/BlockingCollection`1.xml y revisa las secciones Remarks de GetConsumingEnumerable(), GetConsumingEnumerable(CancellationToken) y Take. Añade la explicación solicitada del método sin parámetros y aclara cuándo es preferible GetConsumingEnumerable a Take en un bucle. El trabajo estará terminado cuando la documentación de la API relacionada explique explícitamente su relación sin depender de la sobrecarga con cancelación.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
csharp
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.