DiamondLightSource / DiamondLightSource/cssgen
Clean up API
Open
- Dominant language
- Python
- Stars
- 0
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
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. `.add_renderer()` to `.add()` and make it simpler to understand.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.