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
Create how to on custom local components #343
Conversation
Codecov Report
@@ Coverage Diff @@
## master #343 +/- ##
=======================================
Coverage 67.22% 67.22%
=======================================
Files 71 71
Lines 7340 7340
=======================================
Hits 4934 4934
Misses 2406 2406 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Maybe this is still WIP but shouldn't this How-to actually describe how to write the code of a custom compoment? I.e. you have to create a class that inherits from a base class, you have to define transform_type to define the name by which you will be referring to that component in the spec, you have to implement the apply method with this signature and returning that type of object, create Parameters, specify _field_params, etc. |
@maximlt, according to the plan by @philippjfr , there are separate how-to guides planned for
This PR is much simpler and is intended just to cover how to use those components, once created. |
Yeah, let's keep that separate. However one thing that wasn't documented elsewhere and should be here is that you can import a component by its module path, e.g. you can do |
@philippjfr can we merge this now? |
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
import a component by its module path, e.g. you can do my_library.some_module.MyTransform
Also made the install page more explicit about python installation after a good talk with @Hoxbro.
Also included some minor fixes like syntax highlighting and a couple of links