Fix markdown "break on newline" configurability #236
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, `"break-on-newline": True` was part of the default markdown options. The user could override the configuration value, thus turning it into `"break-on-newline": False`, but unfortunately the markdown2 library ignores the value of the option, and always sets it to `True` if the key is passed in. The `break-on-newline` extra is deprecated, there is a new option since 2.4.11: `breaks` https://github.com/trentm/python-markdown2/wiki/breaks Unfortunately, markdown2 overrides the `breaks.on_newline` configuration if `break-on-newline` is present in the extras, meaning that this doesn't work for disabling "break on newline" either. This means that right now there is _no_ way for the users of jsfh to disable line breaks on newlines. To fix this, remove `break-on-newline` from the default markdown options. If (and only if) the `breaks` config is _not_ set by the user, a `breaks` config is added to the defaults that inserts line breaks on newlines by default.
|
(As a sidenote, the |
|
I'd love to see this get it so that we can disable break on newline. Is there more work to be done here @dblanchette ? |
|
@threema-danilo I think it would also be good to update the |
|
@estan thanks for the update! I don't currently have the free capacity to work on this issue, but feel free to push changes to my branch in order for it to conform to your project standards 🙂 |
dblanchette
pushed a commit
that referenced
this pull request
Nov 29, 2024
## [1.3.1](v1.3.0...v1.3.1) (2024-11-29) ### Bug Fixes * Fix markdown "break on newline" configurability ([#236](#236)) ([c0c9d09](c0c9d09))
|
🎉 This PR is included in version 1.3.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously,
"break-on-newline": Truewas part of the default markdown options. The user could override the configuration value, thus turning it into"break-on-newline": False, but unfortunately the markdown2 library ignores the value of the option, and always sets it toTrueif the key is passed in.The
break-on-newlineextra is deprecated, there is a new option since 2.4.11:breakshttps://github.com/trentm/python-markdown2/wiki/breaks Unfortunately, markdown2 overrides thebreaks.on_newlineconfiguration ifbreak-on-newlineis present in the extras, meaning that this doesn't work for disabling "break on newline" either.This means that right now there is no way for the users of jsfh to disable line breaks on newlines. To fix this, remove
break-on-newlinefrom the default markdown options. If (and only if) thebreaksconfig is not set by the user, abreaksconfig is added to the defaults that inserts line breaks on newlines by default.