Some markdown-formatted remarks are ported into triple slash comments with invalid structure
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 42/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- csharp
- Área
- documentation, tooling
Línea de trabajo
Compara las remarks de MemoryManager`1.xml con los comentarios de triple barra de MemoryManager.cs resultantes que se muestran en el issue. Traza la ruta de portabilidad de la documentación que procesa los elementos remarks y format, y verifica después que las remarks generadas tengan una estructura válida sin contenido duplicado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
As seen in MemoryManager<T> from System.Memory in dotnet/runtime, some <remarks> sections are getting produced with invalid structure, and duplicated content.
From `MemoryManager`1.xml`
<Docs>
<typeparam name="T">The type of items in the memory buffer managed by this memory manager.</typeparam>
<summary>An abstract base class that is used to replace the implementation of <see cref="T:System.Memory`1" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
The `MemoryManager<T>` class is used to extend the knowledge of types that <xref:System.Memory%601> is able to represent. For example, you can derive from `MemoryManager<T>` to allow <xref:System.Memory%601> to be backed by a <xref:System.Runtime.InteropServices.SafeHandle>.
> [!NOTE]
> The `MemoryManager<T>` class is intended for advanced scenarios. Most developers do not need to use it.
]]></format>
</remarks>
</Docs>
Before porting the docs into triple slash comments, this was the content of MemoryManager.cs:
/// <summary>
/// Manager of <see cref="System.Memory{T}"/> that provides the implementation.
/// </summary>
public abstract class MemoryManager<T> : IMemoryOwner<T>, IPinnable
After porting, this is the result:
/// <summary>An abstract base class that is used to replace the implementation of <see cref="System.Memory{T}" />.</summary>
/// <typeparam name="T">The type of items in the memory buffer managed by this memory manager.</typeparam>
/// <remarks>The `MemoryManager<T>` class is used to extend the knowledge of types that <see cref="System.Memory{T}" /> is able to represent. For example, you can derive from `MemoryManager<T>` to allow <see cref="System.Memory{T}" /> to be backed by a <see cref="System.Runtime.InteropServices.SafeHandle" />.
/// <format type="text/markdown"><![CDATA[
/// > [!NOTE]
/// > The `MemoryManager<T>` class is intended for advanced scenarios. Most developers do not need to use it.
/// ]]></format></remarks>
public abstract class MemoryManager<T> : IMemoryOwner<T>, IPinnable
The <remarks> section has the content duplicated, once inside the <format> and once before it, which is an invalid structure.
- Lenguaje dominante
- C#
- Estrellas
- 14
- Forks
- 21
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de dotnet/api-docs-sync
-
Dificultad 3/5 1-2 días Aptitud para principiantes 42/100
dotnet/api-docs-sync#182 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
dotnet/api-docs-sync#181 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
dotnet/api-docs-sync#180 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
dotnet/api-docs-sync#179 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
dotnet/api-docs-sync#178 · 1 comentario ·
Todos los issues de dotnet/api-docs-sync
Issues similares
-
type/automation type/tech-debt
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
t/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
ci-failure-cause test-failure
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
area:auth FE mvp P3
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
klasolsson81/jobbliggaren#1788 ·