Replace deprecated 'headerFooter' by 'standalone' #1161
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
5 tasks
abelsromero
force-pushed
the
issue-1160-replace-headerFooter-with-standalone
branch
from
a1e6bbc
to
af39c81
Compare
* Replace headerFooter methods in OptionsBuild & Options * Update referenes to the old methods * Added 'standalone' description to docs * Re-ordered options in docs to follow alphabetical order * Remove some unnecessary throws from tests * Add missing '@deprecated' to templateDir method Fixes asciidoctor#1160
robertpanzer
reviewed
Apr 7, 2023
| public class Options { | ||
|
|
||
| public static final String IN_PLACE = "in_place"; | ||
| public static final String ATTRIBUTES = "attributes"; | ||
| public static final String HEADER_FOOTER = "header_footer"; |
There was a problem hiding this comment.
I wonder if we want to at least keep the constant?
Even if the option is not recommended, Asciidoctor itself still handles it.
There was a problem hiding this comment.
I thought about it, my rationale was that if this is not the recommended way, we should not make it easy to use. Users can still use it as a String if they want, but since we had no references in the current code we could remove it.
We could add it back, I admit I am being very strict with the "let's clean thing now that we can to breaking changes" 😄
|
Thank you! |
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.
Kind of change
Description
What is the goal of this pull request?
Replace deprecated 'headerFooter' by 'standalone'
Other changes included:
How does it achieve that?
Simply rename method and change the use of the
header_footeroption in the internal map bystandalone.Are there any alternative ways to implement this?
We could have deprecated the
headerFootermethod but since this is for v3.0.0...breaking changes are ok.I'll create a PR to deprecate in v2.5.x
Are there any implications of this pull request? Anything a user must know?
No.
Issue
If this PR fixes an open issue, please add a line of the form:
Fixes #1160
Release notes
Please add a corresponding entry to the file CHANGELOG.adoc