Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated from Asciidoctor interface #1207

Conversation

abelsromero
Copy link
Member

@abelsromero abelsromero commented May 21, 2023

Kind of change

  • Bug fix
  • New non-breaking feature
  • New breaking feature
  • Documentation update
  • Build improvement

Description

What is the goal of this pull request?

  • Remove deprecated methods in org.asciidoctor.Asciidoctor interface to streamline API.
    Just methods using org.asciidoctor.Options remain now.
  • Remove readDocumentHeader methods and org.asciidoctor.ast.DocumentHeader class

⚠️ IMPORTANT: This is a branch from the branch in PR #1200, this is to be merged later, I am marking as draft for now as a reminder. No rush, there's plenty of time.

How does it achieve that?

Simply remove the methods and refactor the required code.
Special mention to WhenDocumentHeaderIsRequired test, we could remove it, but I just reimplemented with the new API to ensure users can still obtain the same information.

Are there any alternative ways to implement this?
No, it's only remove, no changes in the methods lefts.

Are there any implications of this pull request? Anything a user must know?

It's breaking for v3.0.0 but we add a migration guide to help.

Issue

Fixes #1201

Release notes

Please add a corresponding entry to the file CHANGELOG.adoc

@abelsromero abelsromero force-pushed the issue-1201-remove-deprecated-from-Asciidoctor-interface branch from 2b96db9 to 5b20ad4 Compare May 21, 2023 19:56
@abelsromero
Copy link
Member Author

@mojavelinux I am documenting on the migration guide how to use parse_header_only option, but I suspect this is one of those internal things that users should not use? Is that the case?

@abelsromero abelsromero force-pushed the issue-1201-remove-deprecated-from-Asciidoctor-interface branch from 5b20ad4 to 9241818 Compare May 22, 2023 21:02
@robertpanzer robertpanzer marked this pull request as ready for review May 29, 2023 14:08
@abelsromero abelsromero force-pushed the issue-1201-remove-deprecated-from-Asciidoctor-interface branch from 9241818 to fbd2838 Compare May 29, 2023 18:53
@abelsromero
Copy link
Member Author

Rebased from main, ready for review 🎉

@abelsromero abelsromero requested a review from robertpanzer May 30, 2023 08:53
Copy link
Member

@robertpanzer robertpanzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@robertpanzer robertpanzer merged commit 8e336da into asciidoctor:main May 30, 2023
@robertpanzer
Copy link
Member

Thanks!

@abelsromero abelsromero deleted the issue-1201-remove-deprecated-from-Asciidoctor-interface branch November 26, 2023 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove deprecated methods from Asciidoctor interface
2 participants