search

asciidoctor / asciidoctorj

:coffee: Java bindings for Asciidoctor. Asciidoctor on the JVM!
http://asciidoctor.org
Apache License 2.0
627 stars 172 forks source link

Fixes #1068. Clarify execution order of extensions #1069

Closed robertpanzer closed 2 years ago

robertpanzer commented 2 years ago

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

This PR clarifies the documentation wrt the execution order of extensions.

abelsromero commented 2 years ago

I saw a previous typo it’s correspondent HTML or PDF output, should not use 's` maybe we can take the oportunity to fix it.

robertpanzer commented 2 years ago

@mojavelinux Merry Christmas to you and the entire Asciidoctor community! I tested a bit with the execution order of extensions and also trying to figure out the correct order from the Asciidoctor sources. Can you check if this is clear enough and correct to help users understand the execution order, but also not to artificially restrict implementation details. (Some might argue that anything mentioned here is an API contract that must never change in the future without a major release, and I'd like to avoid navigating us into such a situation.)

mojavelinux commented 2 years ago

I left some comments for clarification. The order is right, but the explanations still need to be more precise.

robertpanzer commented 2 years ago

Updated the document.

robertpanzer commented 2 years ago

Merging this for now. If there is further feedback we can still create a new PR.