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

Clean up API

Abierto
#22 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python
Área
tooling

Línea de trabajo

Comienza inventariando los nombres públicos mostrados en cssgen.borders.OpiBorderRenderer y cssgen.render.get_opi_renderer(), incluidas las clases de renderer y add_renderer(). Decide qué renombrados de clases, métodos, módulos y paquetes entran en el alcance, y luego rastrea sus referencias. Se considera terminado cuando la API elegida se haya renombrado de forma coherente, sin dejar atrás la repetición documentada ni una nomenclatura ambigua.

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

Descripción

The API contains a lot of repetition of words:
e.g. in cssgen.borders.OpiBorderRenderer
self._text_renderer = text_renderer
self._text_renderer.render(...)
and in cssgen.render.get_opi_renderer()
tr = OpiTextRenderer()
wr = OpiWidgetRenderer(tr)
cr = colors.OpiColorRenderer()
wr.add_renderer('background_color', cr)
This makes the API unnecessarily verbose.

The class, module and package names are not always self explanatory.

Renaming some classes, methods and package could simplify this, e.g. <renderer>.add_renderer() to <renderer>.add() and make it simpler to understand.

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

Preparar el entorno

Aún no hemos revisado los archivos de configuración de este proyecto. 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 DiamondLightSource/cssgen

Todos los issues de DiamondLightSource/cssgen

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.