Improve usage info in docstrings
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation, tooling
Línea de trabajo
Comienza en el punto de entrada de la generación de docstrings y reproduce el formato mostrado en el issue. Sigue cómo se ensamblan la descripción y la línea de Usage, y verifica después que la salida generada separe claramente Usage de la línea de descripción final y siga siendo legible.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
What
Improve the docstring generation so that it'd doesn't butt usage up below the last line of the description.
Why
still be presented with standard Host UI for the type as an
option.
* If the "exclusive" property is set to true, then the Manager
takes exclusive control over data with the queried trait set,
and any standard host interfaces etc should be suppressed.
Usage: managementPolicy
Its a bit hard to grok, some whitespace, or moving before the body text might help?
- Lenguaje dominante
- Python
- Estrellas
- 7
- Forks
- 7
- Merge medio
- 1 h 7 min
- PR fusionados (30 d)
- 1
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 OpenAssetIO/OpenAssetIO-TraitGen
-
Dificultad 4/5 3-5 días Aptitud para principiantes 38/100
OpenAssetIO/OpenAssetIO-TraitGen#123 · 2 comentarios ·
-
good first issue
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
OpenAssetIO/OpenAssetIO-TraitGen#93 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
OpenAssetIO/OpenAssetIO-TraitGen#84 · 2 comentarios ·
-
Trait mutual exclusivityAbiertobreaking change risk
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Todos los issues de OpenAssetIO/OpenAssetIO-TraitGen
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
With emit_ontology_keys, one ontology key change is reported as two errors (keys and keys_digest)Posiblemente ocupada @rvandewater la tomó hoy. Abiertobug priority:low
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 84/100
iausathub/satchecker#286 ·
Los mantenedores suelen responder en 1 día
-
bug test
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
OpenAssetIO/OpenAssetIO#1527 ·
-
automated endpoint-dead needs-curation
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
almanac-data/climate-almanac#128 ·
Los mantenedores suelen responder en 1 día