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

Throw an error if unexpected keys are provided #2306

Closed
laborg opened this issue Oct 24, 2023 · 0 comments · Fixed by #2324
Closed

Throw an error if unexpected keys are provided #2306

laborg opened this issue Oct 24, 2023 · 0 comments · Fixed by #2324

Comments

@laborg
Copy link
Contributor

laborg commented Oct 24, 2023

I thought I stumbled over this bug #936 but what I actually missed is the initial upper case of Pages in the @contents block.

It would be good to throw an error when unexpected or misspelled keys are provided.

@autodocs only accepts: Modules, Filter, Pages, Private, Public, Order. Example keys that would error: Module, pages, DocTestSetup
@contents should only accept Pages and Depth
...

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

Successfully merging a pull request may close this issue.

2 participants