Footnotes improvements #1218
Merged
Footnotes improvements #1218
Conversation
This file contains hidden or 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
- The placeholder '{}' is optional. So a user can choose to include or
not the footnote number in the backlink text.
- The modification is backward compatible with configurations using
the old '%d' placeholder.
- The addition of a new SUPERSCRIPT_TEXT option allows to specify a placeholder receiving the footnote number for the superscript text.
|
These look like some good improvements/changes to me. Of course, we do need to include an update to the changelog. However, as this is adding a new feature, it will need to be in a new feature release, which means a new document will need to be added for the release notes. However, we already have PR #1187 which handles that. This can be finalized and merged after that. |
|
Oh, I just realized there are no tests for the new features. We also need some new tests added to tests/test_syntax/extensions/test_footnotes.py. |
|
Thanks for the review, tests are added and passing |
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.
Hi, I suggest in this PR 2 improvements for the footnotes module.
Small refactor of the
BACKLINK_TITLEoption; The use offormat()instead of "old"%dformatter allowsto specify text without the need to have the number of the footnote in it (like footnotes on Wikipedia for example).
The modification is backward compatible so no configuration change is required.
Addition of a new option
SUPERSCRIPT_TEXTthat allows to specify a custom placeholder for the footnote itself in the text.Ex: [1] or (1) or just by default, the current behavior: 1.
Some writing rules specify these subtleties I think it could be useful.
Thanks for reading.