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

Documentation suggests that you can just name your group #3022

Open
martinthomson opened this issue Feb 5, 2025 · 1 comment
Open

Documentation suggests that you can just name your group #3022

martinthomson opened this issue Feb 5, 2025 · 1 comment

Comments

@martinthomson
Copy link

Documentation:

You can put whatever value you want into the "Group" value, though. Unrecognized values will just use the default boilerplate files. If you want to add specialized boilerplate files for your group, check out the File-Based Includes section, later in this document, and write your own files.

Actuality:

FATAL ERROR: Unknown Group 'mygroup'. See docs for recognized Group values.

The documentation should reflect whatever reality exists.

However, I would also suggest that the documentation has the preferred state, not the code. The case where I observed this was perfectly able to use the "Org" metadata (set to "W3C") to obtain boilerplate. It should not be the case that you have to setup custom boilerplate for every use of the tool.

@tabatkins
Copy link
Collaborator

There's a trade-off here, between allowing unrecognized groups to still get the generic Org boilerplate, and catching unintentional typos. I know there were several specs misspelling their Groups, so I opted toward catching typos.

But you're right, I should continue to allow unrecognized groups somehow. (And update the docs, sorry about that.)

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

2 participants