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

shrink public API surface in core runtime #474

Merged
merged 2 commits into from
Jul 14, 2023
Merged

shrink public API surface in core runtime #474

merged 2 commits into from
Jul 14, 2023

Conversation

jenshalm
Copy link
Contributor

@jenshalm jenshalm commented Jul 14, 2023

This is the penultimate PR for #452.

It covers the packages laika.render and laika.rewrite.

These packages represent parts of the internal runtime and the few remaining public types in these packages will move in the final milestone.

laika.render

  • The renderer implementations are removed from the public API as they are usually not directly referenced in user code.
  • The formatter implementations remain public API, as they are used when writing render overrides or implementing a new type of renderer, but will most likely receive some redesign and cleanup in the final milestone for 1.0.

laika.rewrite

  • Remaining public types are usually used in configuration code and will move to either laika.bundle or laika.config in the final milestone.
  • Removed from public API: ReferenceResolver, LinkResolver, DocumentTargets, TreeTargets and all their helper ADTs, TitleDocumentConfig, SectionBuilder , NavigationOrder.

@jenshalm jenshalm added this to the 1.0.0-M2 milestone Jul 14, 2023
@jenshalm jenshalm changed the title shr shrink public API surface in core runtime Jul 14, 2023
@jenshalm jenshalm merged commit a5b143d into main Jul 14, 2023
21 checks passed
@jenshalm jenshalm deleted the api/internal branch July 14, 2023 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant