A provider with a custom constructor.
Since the custom constructor parameters match the provider‘s fields, we don’t need to render a separate table of constructor parameters.
FIELDS
| Name | Description |
|---|---|
| foo | Foo data |
| bar | Bar data. |
A provider with a custom constructor with a parameter with a default value.
Since the custom constructor parameters match the provider‘s fields, we don’t need to render a separate table of constructor parameters - but we do need to render the default value.
FIELDS
| Name | Description | Default Value |
|---|---|---|
| foo | Foo data | none |
| bar | Bar data. | 42 |
A provider with a custom constructor with documented constructor parameters.
Docs for constructor parameters differ from docs for fields, so we need to render constructor parameters as a separate table.
CONSTRUCTOR PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| foo | Foo data; must be non-negative | none |
| bar | Bar data. Note that we didn't document bar parameter for the init callback - we want this docstring to be propagated to the constructor param table. | 42 |
FIELDS
| Name | Description |
|---|---|
| foo | Foo data |
| bar | Bar data. Note that we didn't document bar parameter for the init callback - we want this docstring to be propagated to the constructor param table. |
A provider with a custom constructor whose set of constructor parameters does not equal the provider's set of fields.
We have no choice - we need to render constructor parameters as a separate table.
CONSTRUCTOR PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| foo | Foo data | none |
| bar | Bar data. | none |
FIELDS
| Name | Description |
|---|---|
| foo | Foo data |
| bar | Bar data. |
| validated | True, hopefully |
You can read this info.
But should you really construct it?
DEPRECATED
Do not construct!
FIELDS
| Name | Description |
|---|---|
| foo | Foo |
Stores information about a foo.
FIELDS
| Name | Description |
|---|---|
| bar | - |
| baz | - |
A provider with some really neat documentation.
Look on my works, ye mighty, and despair!
FIELDS
| Name | Description |
|---|---|
| favorite_food | A string representing my favorite food Expected to be delicious. |
| favorite_color | A string representing my favorite color |