Stale code comments found while writing the format docs

Ouverte Adaptée aux débutants
#167 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
csharp
Domaine
documentation

Piste de recherche

Commencez par RecordFileWriter.Write, RecordField.ContentMediaType, MarkdownDiagnosticIds, ADR 0032, ADR 0029 et le README ; PR #166 apporte du contexte pour la documentation du format. Comparez chaque commentaire et chaque énoncé de la documentation au comportement du code décrit dans l’issue, y compris l’issue distincte concernant le formulaire du presse-papiers. Le travail est terminé lorsque les quatre descriptions obsolètes correspondent au comportement actuel.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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).
Langage dominant
C#
Étoiles
0
Forks
0
Merge moyen
1 h 43 min
PR mergées (30 j)
43

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de sillsdev/SIL.TextEditing

Toutes les issues de sillsdev/SIL.TextEditing

Issues similaires

Plus d'issues C#

Recevez les nouvelles issues par e-mail

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