doc: correct exported call API contracts
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
- 78/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- go
- Área
- api, documentation
Línea de trabajo
Empieza en runtime/gorumsimpl/call.go, donde los comentarios de documentación de QuorumCall, QuorumCallStream y Multicast afirman que se produce un panic con una configuración vacía. Confirma en las implementaciones que devuelven handles que informan ErrEmptyConfig al consumirse, y luego revisa la documentación de la llamada exportada correspondiente y de los clientes generados. Está terminado cuando cada comentario afectado describe ese comportamiento y las notas sobre el despacho y el reporte de errores coinciden con el código.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Problem
Some exported runtime documentation disagrees with the implementation.
In runtime/gorumsimpl/call.go, the comments for QuorumCall, QuorumCallStream, and Multicast say they panic for an empty configuration.
The implementations instead return handles that report ErrEmptyConfig when consumed.
Work
- Correct these comments and check the corresponding exported call and generated-client documentation for the actual empty-configuration behavior.
- Check related contracts for consistency with the implementations, including when a call is dispatched and where errors are reported.
- Keep descriptions concise and link relevant public types and methods.
This is a focused correctness fix.
The broader documentation cleanup is tracked separately.
Migration guide work is tracked by #397.
- Lenguaje dominante
- Go
- Estrellas
- 149
- Forks
- 15
- Merge medio
- 1 d 8 h
- 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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de relab/gorums
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 22/100
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 15/100
Los mantenedores suelen responder en 1 día
-
sweep: command documentationAbiertodoc
Dificultad 3/5 Medio día Aptitud para principiantes 45/100
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
Todos los issues de relab/gorums
Issues similares
-
go good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
-
Response matcher: a changed integer above 2^53 passes because JSON numbers are compared as float64Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
dec2hex rejects integer literals and accepts string literals in SQLPosiblemente ocupada @NopeCharon la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día