You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some form types extend other parent types (e.g. CountryType and EnumType extend ChoiceType). In the docs of the child classes, we display all options defined by them and all options defined by their parent types.
However, we handle this manually, so we miss options from time to time (this is a recurrent problem; see #2360).
So, we have two options:
Re-check all options again and fix errors manually
Re-think how we solve this
About rethinking:
We could just list the names of all the inherited options and link to the parent descriptions, instead of embedding all the descriptions in all child constrains
We could add some PHP logic in the docs-builder tool used to build docs to fix this somehow
Thoughts?
The text was updated successfully, but these errors were encountered:
We could just list the names of all the inherited options and link to the parent descriptions, instead of embedding all the descriptions in all child constrains
Would be easier to maintain, but harder to consume by the user IMHO
We could add some PHP logic in the docs-builder tool used to build docs to fix this somehow
Would avoid manual errors, but hard to achieve with versionadded directives, without comparing to older branches I think.
As a first step of simplification, instead of including the options one by one, could we group them together in a parent class file and include that ? This implies that we can use include in an rst.inc file, I don't know if that's possible.
This would allow, if we take EnumType as an example, to include a file like choice_options.rst.inc which would itself include the twenty files for the different options.
Then, if a ChoiceType option is added tomorrow, we only have to add it in one place, without having to check every type that inherits from ChoiceType.
Some form types extend other parent types (e.g. CountryType and EnumType extend ChoiceType). In the docs of the child classes, we display all options defined by them and all options defined by their parent types.
However, we handle this manually, so we miss options from time to time (this is a recurrent problem; see #2360).
So, we have two options:
About rethinking:
Thoughts?
The text was updated successfully, but these errors were encountered: