Para tags are mangled when explicitly declared in remarks in combination with new-lines
- Langage dominant
- C#
- Étoiles
- 14
- Forks
- 21
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
See https://github.com/dotnet/runtime/blob/925205d06d82ce5e0d24e4e313fd66887fe89795/src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/CollectionsMarshal.cs#L50-L60
This produced escaped para tags that required fixup https://github.com/dotnet/dotnet-api-docs/commit/88e32343860fb4f40d147a602f982f753bbaa027#diff-f01295b45b7c030a49d50f0e76b8ffb9e41e3c2238ae1bc6097cc1b781570ad5L61
We should investigate what's going wrong and fix the tool
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par comparer les remarques dans CollectionsMarshal.cs aux lignes 50-60 avec la modification des api-docs générés liée dans l’issue. Suivez la manière dont l’outil documentation-sync gère les para tags déclarées explicitement et les retours à la ligne. C’est terminé lorsque l’outil n’émet plus de escaped para tags nécessitant une correction manuelle.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- csharp
- Domaine
- documentation, tooling
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100