Possible naming improvements
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
Línea de trabajo
Comienza revisando los puntos de entrada públicos mencionados en el issue: pyannotate_runtime, collect_types.init_types_collection(), resume(), dump_stats() y los propuestos start(), stop() y dump(). Determina si se pretende realizar la consolidación solicitada de la API y el cambio de inicialización, y define la nomenclatura final y el comportamiento de las importaciones antes de la implementación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I was a bit surprised when approaching the package by the complexity of the naming.
What surprised me :
- the tool is named pyannotate but you must import pyannotate_runtime to use it
- collect_types.init_types_collection() ? Does the name really need to be that long ? Do we really need to explicitly init by the way ? Why not initialize on first resume() ?
- dump_stats() is ok but dump() is good too
Suggestions :
- allow to import directly from pyannotate
- 3 functions only : start(), stop(), dump()
- initialize on first start() or rename init_types_collection() to init()
By the way, I am looking into contributing to pyannotate.
- Lenguaje dominante
- Python
- Estrellas
- 1.4k
- Forks
- 59
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
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 dropbox/pyannotate
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
dropbox/pyannotate#124 · 3 reacciones ·
-
Test failures on Python 3.12Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
dropbox/pyannotate#123 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
dropbox/pyannotate#115 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
dropbox/pyannotate#109 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
dropbox/pyannotate#103 · 6 comentarios · 1 reacción ·
Todos los issues de dropbox/pyannotate
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
aws-samples/sample-per-model-bedrock#191 ·
Los mantenedores suelen responder en 1 día
-
Docs viewer: inverted grey colormap, Phantom CT window -20 to 35 HU, smoothing up to 40 mmPosiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abiertoarea: docs enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
PyTomography/PyTomography#331 ·
Los mantenedores suelen responder en 1 día
-
effort: low prio: low ready
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
digitalfabrik/integreat-cms#4616 ·
Los mantenedores suelen responder en 5 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
FuRongJun-1999/dsh-memory#226 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug difficulty:2 good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
MakazhanAlpamys/Soup#1865 ·
Los mantenedores suelen responder en 1 día