dotnet / dotnet/api-docs-sync

Some markdown-formatted remarks are ported into triple slash comments with invalid structure

Ouverte
#68 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
port-to-tripleslash
Langage dominant
C#
Étoiles
14
Forks
21
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

As seen in `MemoryManager` from `System.Memory` in `dotnet/runtime`, some `` sections are getting produced with invalid structure, and duplicated content.

From `` `MemoryManager`1.xml` ``

```xml

The type of items in the memory buffer managed by this memory manager.
An abstract base class that is used to replace the implementation of .

` class is used to extend the knowledge of types that is able to represent. For example, you can derive from `MemoryManager` to allow to be backed by a .

> [!NOTE]
> The `MemoryManager` class is intended for advanced scenarios. Most developers do not need to use it.

]]>


```

Before porting the docs into triple slash comments, this was the content of `MemoryManager.cs`:

```csharp
///
/// Manager of that provides the implementation.
///
public abstract class MemoryManager : IMemoryOwner, IPinnable
```

After porting, this is the result:

```csharp
/// An abstract base class that is used to replace the implementation of .
/// The type of items in the memory buffer managed by this memory manager.
/// The `MemoryManager` class is used to extend the knowledge of types that is able to represent. For example, you can derive from `MemoryManager` to allow to be backed by a .
/// [!NOTE]
/// > The `MemoryManager` class is intended for advanced scenarios. Most developers do not need to use it.
/// ]]>
public abstract class MemoryManager : IMemoryOwner, IPinnable
```

The `` section has the content duplicated, once inside the `` and once before it, which is an invalid structure.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.