Describe the bug
context
When upgrading from 0.17.0 to 0.17.2, configuration now errors out due to the warning:
The config value `myst_url_schemes' has type `list', defaults to `tuple'.
Given the sphinx configuration of:
myst_url_schemes = ['https', 'http']
expectation
I expected this change to have been documented in the CHANGELOG, such that I could understand that a breaking change was introduced.
bug
But instead it looked like only an internal refactor took place.
Reproduce the bug
Use configuration of myst_url_schemes = ['https', 'http'] for myst_parser 0.17.0, build your documentation, the build will succeed; Upgrade to 0.17.2 and the build will begin to fail, wanting myst_url_schemes = ('https', 'http') instead.
List your environment
MyST_parser 0.17.2
python3.9 (I'm using sphinx-build)
Describe the bug
context
When upgrading from 0.17.0 to 0.17.2, configuration now errors out due to the warning:
Given the sphinx configuration of:
expectation
I expected this change to have been documented in the CHANGELOG, such that I could understand that a breaking change was introduced.
bug
But instead it looked like only an internal refactor took place.
Reproduce the bug
Use configuration of
myst_url_schemes = ['https', 'http']for myst_parser 0.17.0, build your documentation, the build will succeed; Upgrade to 0.17.2 and the build will begin to fail, wantingmyst_url_schemes = ('https', 'http')instead.List your environment
MyST_parser 0.17.2
python3.9 (I'm using sphinx-build)