Stale code comments found while writing the format docs

Abierto Apto para principiantes
  • ¿Algo no está bien?
#167 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
csharp
Área
documentation

Línea de trabajo

Empieza con RecordFileWriter.Write, RecordField.ContentMediaType, MarkdownDiagnosticIds, ADR 0032, ADR 0029 y el README; PR #166 aporta contexto para la documentación del formato. Compara cada comentario y cada afirmación de la documentación con el comportamiento del código descrito en el issue, incluido el issue separado para el formulario del portapapeles. Se habrá terminado cuando las cuatro descripciones obsoletas coincidan con el comportamiento actual.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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).
Lenguaje dominante
C#
Estrellas
0
Forks
0
Merge medio
1 h 43 min
PR fusionados (30 d)
43

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de sillsdev/SIL.TextEditing

Todos los issues de sillsdev/SIL.TextEditing

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.