Document breaking changes to processors in migration guide #1210
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
abelsromero
approved these changes
May 29, 2023
| Moreover, there was a problem with the first parameter of the process method in InlineMacroProcessors. | ||
| Previously, it incorrectly expected a PhraseNode as the first parameter. | ||
|
|
||
| To resolve this issue, AsciidoctorJ 3.x.x has rectified the first parameter of InlineMacroProcessor::process to be a StructuralNode. |
| Make sure to modify your implementation to return a StructuralNode as required. | ||
|
|
||
| Moreover, there was a problem with the first parameter of the process method in InlineMacroProcessors. | ||
| Previously, it incorrectly expected a PhraseNode as the first parameter. |
There was a problem hiding this comment.
I like to make it clear when I am pointing to a class or method using backticks (`).
Suggested change
| Previously, it incorrectly expected a PhraseNode as the first parameter. | |
| Previously, it incorrectly expected a `PhraseNode` as the first parameter. |
| @@ -0,0 +1,43 @@ | |||
| == Update Preprocessors | |||
|
|
|||
| In earlier versions of AsciidoctorJ (up to 2.5.x), Preprocessors were provided with a Reader object that they had to modify directly. | |||
There was a problem hiding this comment.
Suggested change
| In earlier versions of AsciidoctorJ (up to 2.5.x), Preprocessors were provided with a Reader object that they had to modify directly. | |
| In earlier versions of AsciidoctorJ (up to 2.5.x), Preprocessors were provided with a `Reader` object that they had to modify directly. |
| } | ||
| ---- | ||
|
|
||
| You may find it helpful to review the methods Processor::newReader and PreprocessorReader::read to simplify your code when creating a new Reader and reading the content of the existing Reader. |
There was a problem hiding this comment.
Suggested change
| You may find it helpful to review the methods Processor::newReader and PreprocessorReader::read to simplify your code when creating a new Reader and reading the content of the existing Reader. | |
| You may find it helpful to review the methods `Processor::newReader` and `PreprocessorReader::read` to simplify your code when creating a new Reader and reading the content of the existing Reader. |
robertpanzer
force-pushed
the
extension-migration-guide
branch
from
9341dd7 to
dfb44e3
Compare
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.
Thank you for opening a pull request and contributing to AsciidoctorJ!
Please take a bit of time giving some details about your pull request:
Kind of change
Description
What is the goal of this pull request?
This PR documents the breaking changes to the processor API in the migration guide from 2.5.x to 3.x.x.
(Please note that I used ChatGPT to rephrase parts of that text to better convey the necessary steps, I often find myself writing texts that native speakers are not able to follow (guess whose fault that is 😜))