Example config files omit the `presence:` block the parser accepts

Abierto Apto para principiantes
#60 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
69/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
rust

Línea de trabajo

Lee crates/podd-core/src/config/mod.rs para ver los campos de PresenceConfig y ARCHITECTURE.md para conocer el contexto de la API. Luego revisa config.example.ron, config.pod3.example.ron y config.pod4.example.ron para ver cómo se documentan las opciones. La tarea estará terminada cuando los ejemplos expliquen los tres campos de presence en un bloque comentado o indiquen claramente que presence solo está disponible en tiempo de ejecución.

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

Descripción

documentation good first issue

crates/podd-core/src/config/mod.rs defines Config.presence: Option<PresenceConfig> (fields baselines: [u16;6], threshold: u16, debounce_count: u8), and ARCHITECTURE.md documents a GET/POST /metrics/presence API around it, but none of config.example.ron, config.pod3.example.ron, or config.pod4.example.ron mention presence at all. A user has no documented way to discover or shape this option. Add a commented-out presence: (...) block (with the three fields and their meaning) to the example configs, or explicitly note it's runtime-only.


Filed from a repo-wide code audit (working tree at bcad746).

Lenguaje dominante
Rust
Estrellas
0
Forks
0
Métricas de merge de PR
Sin PR fusionados en 30 d

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 GoogleBot42/podd

Todos los issues de GoogleBot42/podd

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.