Skip to content

Commit

Permalink
v3 migration guide for 'extension' removed methods
Browse files Browse the repository at this point in the history
Fixes #1203
  • Loading branch information
abelsromero committed Jun 1, 2023
1 parent 64eea8a commit a560ad4
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ Improvement::
* Return Document AST when using convert or convertFile with appropriate options (#1171) (@abelsromero)
* Expose Links in the catalog (#1183) (@abelsromero)
* BREAKING: Remove deprecated methods in Options, OptionsBuilder, Attributes & AttributesBuilder (#1199) (@abelsromero)
* BREAKING: Remove deprecated Asciidoctor interface (#1201) (@abelsromero)
* BREAKING: Remove deprecated methods from Asciidoctor interface (#1201) (@abelsromero)
* BREAKING: Remove deprecated methods from Document interface (#1202) (@abelsromero)
* BREAKING: Remove deprecated methods and constants from extension package (#1203) (@abelsromero)

Bug Fixes::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ include::partial$removal-of-deprecated-asMap-from-builders.adoc[]
include::partial$removal-of-deprecated-methods-in-asciidoctor.adoc[]

include::partial$removal-of-deprecated-methods-in-document.adoc[]

include::partial$removal-of-deprecated-constants-in-BlockProcessor.adoc[]

include::partial$removal-of-deprecated-methods-in-extension-package.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
== Removal of deprecated constants from `org.asciidoctor.extension.BlockProcessor`

All constants in `org.asciidoctor.extension.BlockProcessor` class that were marked as `@Deprecated` have been removed.

You can find the new values in `org.asciidoctor.extension.Contexts` interface.
See the table below for the equivalencies.

|===
|Deprecated value |Contexts value

|CONTEXTS
|KEY

|CONTEXT_OPEN
|OPEN

|CONTEXT_EXAMPLE
|EXAMPLE

|CONTEXT_SIDEBAR
|SIDEBAR

|CONTEXT_LITERAL
|LITERAL

|CONTEXT_LISTING
|LISTING

|CONTEXT_QUOTE
|QUOTE

|CONTEXT_PASS
|PASS

|CONTEXT_PARAGRAPH
|PARAGRAPH

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== Removal of deprecated methods in `org.asciidoctor.extension` package

Several methods under `org.asciidoctor.extension that were marked as `@Deprecated` have been removed.
The new methods align better with Java naming patterns and are easily identifiable.

[,java]
.Removed deprecated methods
----
PreprocessorReader::push_include
Reader::getLineno
Reader::lines
----

[,java]
.Final methods
----
PreprocessorReader::pushInclude
Reader::getLineNumber
Reader::getLines
----

0 comments on commit a560ad4

Please sign in to comment.