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.

Sign up for GitHub

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

Jump to bottom

Should add_config_value('js_source_path') pass types? #182

Closed
saschanaz opened this issue Oct 5, 2021 · 0 comments · Fixed by #213
Closed

Should add_config_value('js_source_path') pass types? #182

saschanaz opened this issue Oct 5, 2021 · 0 comments · Fixed by #213

Comments

@saschanaz
Copy link

In https://bugzilla.mozilla.org/show_bug.cgi?id=1734199 I'm getting a warning whenever I run ./mach doc:

WARNING: The config value js_source_path' has type list', defaults to `str'.

That message seemingly is from https://github.com/sphinx-doc/sphinx/blob/c922189920ec36fe34aab41ee467a854849a57b8/sphinx/config.py#L456 and caused by:

sphinx-js/sphinx_js/__init__.py

Line 35 in a1ee456

app.add_config_value('js_source_path', '../', 'env')

I guess the call should be something like:

app.add_config_value('js_source_path', '../', 'env', types=[str, list])
@willkg willkg mentioned this issue Dec 10, 2022
Merged
lonnen pushed a commit that referenced this issue Dec 10, 2022
@willkg @lonnen
Add types to add_config_value("js_source_path") call (#182)
62e64e5 
The `type` argument for add_config_value() defaults to `str`, but
`js_source_path` takes a str or list of strings as a value, so this
fixes that.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add types to add_config_value("js_source_path") call (#182)
1 participant
@saschanaz