API Documentation¶
This part of the documentation is currently under construction.
The documentation on this part of the site pertains to the API of Bright and Poke. It is hand-written (for now), however it is kept up to date and tags are added appropriately.
Internals¶
The internals of Bright are also on this documentation, tagged with "Internal", however they should not be used in end-user work. These are documented for developers who want to work on Bright itself and the libraries.
Tags Reference¶
¶
This part of the API is considered experimental, and may change or be removed at any point. This is only applied to APIs that are only available in dev versions of Bright.
¶
This part of the API is for internal use, and is only documented for ease of development. Internal APIs are not considered stable and may potentially break your transformers and/or tooling between non-major versions of Bright. They also do not have any version tag to further discourage their use.
¶
This method call yields the thread.