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

Warn on unsupported arguments in contents, index, autodocs, and meta blocks #2324

Merged
merged 5 commits into from
Nov 12, 2023

Conversation

odow
Copy link
Collaborator

@odow odow commented Nov 1, 2023

Closes #2306

I don't know the best way to test this. I also decided to warn, rather than error, because doing so might break working builds if they have added some additional arguments in there, intentionally or otherwise.

Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM. Anything else you wanted to do here @odow or can we merge this?

@odow
Copy link
Collaborator Author

odow commented Nov 8, 2023

I don't have any other plans. Except I wasn't really sure how to test properly

@mortenpi mortenpi closed this Nov 8, 2023
@mortenpi mortenpi reopened this Nov 8, 2023
@mortenpi
Copy link
Member

mortenpi commented Nov 8, 2023

Except I wasn't really sure how to test properly

In principle, some @test_logs calls in test/errors should probably do it? But it would probably require reorganizing the test, so I'm happy to merge this as is.

@odow
Copy link
Collaborator Author

odow commented Nov 8, 2023

👍

@mortenpi mortenpi closed this Nov 9, 2023
@mortenpi mortenpi reopened this Nov 9, 2023
@mortenpi mortenpi merged commit 7f7c4bd into master Nov 12, 2023
17 of 21 checks passed
@mortenpi mortenpi deleted the od/warn-unsupported-kwarg branch November 12, 2023 21:59
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

Successfully merging this pull request may close these issues.

Throw an error if unexpected keys are provided
2 participants