Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: transformer code needs more types and docstrings #68

Open
boneskull opened this issue Nov 15, 2019 · 0 comments
Open

docs: transformer code needs more types and docstrings #68

boneskull opened this issue Nov 15, 2019 · 0 comments
Labels
chore Related to tests, packaging, build, releases, etc. documentation Improvements or additions to documentation

Comments

@boneskull
Copy link
Contributor

There's a lot of any types still hanging around in here. because it's not yet documented how a user can create a plugin, documentation of the Transformer API was not a priority.

especially concerning I think is the field definition bit. transformer A needs to be able to tell transformer B about its fields and how to display them, if applicable. The key is the "if applicable" part, which indicates to me this is a leaky abstraction. I'd like to rethink this, because it's really fussy to work with--especially when the fields can themselves be overridden by user configuration (YAGNI, perhaps).

@boneskull boneskull added documentation Improvements or additions to documentation chore Related to tests, packaging, build, releases, etc. labels Nov 15, 2019
@boneskull boneskull added this to To do in Documentation via automation Nov 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Related to tests, packaging, build, releases, etc. documentation Improvements or additions to documentation
Projects
Documentation
  
To do
Development

No branches or pull requests

1 participant