Para tags are mangled when explicitly declared in remarks in combination with new-lines

Aperta
#180 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
csharp
Ambito
documentation, tooling

Direzione di ricerca

Inizia confrontando le osservazioni in CollectionsMarshal.cs alle righe 50-60 con la modifica agli api-docs generati collegata nell’issue. Traccia il modo in cui lo strumento documentation-sync gestisce i para tags dichiarati esplicitamente e le nuove righe. Il lavoro è completato quando lo strumento non emette più escaped para tags che richiedono una correzione manuale.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
C#
Stelle
14
Fork
21
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di dotnet/api-docs-sync

Tutte le issue di dotnet/api-docs-sync

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.