Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

docs: README examples no longer match v0.21.0's output

Abierto Apto para principiantes
  • ¿Algo no está bien?
#261 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
77/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go
Área
documentation

Línea de trabajo

Empieza por las secciones citadas en README.md: los ejemplos alrededor de las líneas 1472–1525, la descripción de -V=full, la tabla de directivas mal formadas y los ejemplos de números de línea. Ejecuta los comandos documentados en el commit 510cad4 y compara su salida con cada bloque de README. Actualiza los ejemplos y las afirmaciones obsoletos o incompletos, elige una convención para los números de línea y añade, si resulta práctico, una prueba golden para los bloques survey e inspect; el trabajo estará terminado cuando la salida documentada y las afirmaciones coincidan con los comandos.

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

Descripción

documentation P3

These were checked by running the commands at 510cad4.

Example output

  • "Silencing an unused report" (README.md:591-594): it runs plain declscope ./..., which is strict by default, but shows the loose wording nothing it reaches takes a scope. v0.21.0 prints …on B: it already has shared scope, and the same for T.F.

  • Survey and inspect samples (README.md:1472-1525): several numbers are out of date, and rows are silently left out.

    Item README v0.21.0
    Survey declared 20 29
    markdown → cell mutual empty yes
    markdown → cell reached 7 of 10 7 of 18
    markdown → sink 5 of 17, 28 uses 5 of 18, 25 uses
    golden → (core) 4 of 78 4 of 79
    format → json 2 of 105 2 of 107
    Open declarations 114 109

    The survey sample leaves out the Packages — qualify table. The inspect sample drops rows such as json → summary from the middle of the table, and cuts the "Declarations crossed" sentence short.

Statements

  • -V=full (README.md:227) says "A build from a checkout answers devel". go build in a checkout answers a VCS version. Only go run, or a build with -buildvcs=false, answers devel.

  • The malformed-directive table (README.md:628-630) gives one directive's message for another:

    Input README Actual
    //declscope:core twice duplicate declscope:namespace directive duplicate declscope:core directive
    Two identical ignores duplicate declscope:shared directive duplicate declscope:ignore directive
    A stray //declscope:core declscope:namespace must appear… declscope:core must appear…

  • Line numbers are counted two ways. Most examples treat the // file.go caption as outside the file (lines 114-115, 770-778, 1066 and 1159). The strict-fix example (534-537) and the account.go example (1100) count it as line 1.

Suggested fix

  • Regenerate the samples, or mark them as excerpts.
  • Use <name> in the message table.
  • Pick one convention for line numbers.
  • A golden test over the survey and inspect README blocks would keep them from drifting again.
Lenguaje dominante
Go
Estrellas
42
Forks
1
Merge medio
1 h 18 min
PR fusionados (30 d)
94

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 mpyw/declscope

Todos los issues de mpyw/declscope

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.