Stale code comments found while writing the format docs

Aperta Adatta ai principianti
  • Qualcosa non va?
#167 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
csharp
Ambito
documentation

Direzione di ricerca

Inizia da RecordFileWriter.Write, RecordField.ContentMediaType, MarkdownDiagnosticIds, ADR 0032, ADR 0029 e il README; PR #166 fornisce il contesto per la documentazione del formato. Confronta ogni commento e ogni affermazione della documentazione con il comportamento del codice descritto nell’issue, compresa l’issue separata per il modulo degli appunti. Il lavoro è completato quando tutte e quattro le descrizioni obsolete corrispondono al comportamento attuale.

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

Descrizione

The code is right in each case; only the comments are wrong.

  1. RecordFileWriter.Write's summary says every rich value is a |- block, but under R-8 fields of paragraphs are written with |.
  2. RecordField.ContentMediaType's comment says references are text/x-fieldworks-markdown, but the code returns text/x-fieldworks-markdown-inline. Record the -inline type in ADR 0032 as well.
  3. MarkdownDiagnosticIds says link.ambiguous and link.broken are 'reported by hosts', but ObjectBuilder emits both.
  4. ADR 0029 and the README say the Markdown library 'will provide' the FieldWorks Markdown clipboard form. Only the id constant exists; see the separate issue for the form itself.
    Found by the format-docs work (PR #166).
Lingua principale
C#
Stelle
0
Fork
0
Merge medio
1h 43m
PR unite (30g)
43

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 sillsdev/SIL.TextEditing

Tutte le issue di sillsdev/SIL.TextEditing

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.