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

Components should not have magic words like docs #290

Open
simonrainerson opened this issue Jul 8, 2022 · 0 comments
Open

Components should not have magic words like docs #290

simonrainerson opened this issue Jul 8, 2022 · 0 comments

Comments

@simonrainerson
Copy link
Member

As discussed in #288 components should not give special meanings to attribute names.

One solution mentioned in the PR is:

We could do something like tagging everything created with the base.documentation functions (and add a base.documentation.includeInCombinedDocs function to tag custom derivations), and then do all the special stuff with everything in the component that has the tag. Then it wouldn't matter where in the component they were so it would be a bit flatter.

Another solution would be to add a config setting for what the docs attribute should be called.

We should probably also try to be more consistent about using the config for default target, right now we hardcode package in some places and use the config value (which defaults to package) in other.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant