shrink public API surface in markup parsers #475
Merged
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
11 tasks
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.
This is the final PR for #452.
It covers the packages
laika.markdown(Markdown parser) andlaika.rst(reStructuredText parser) and all their sub-packages.Both parsers are completely removed from public API, as it is unlikely that user code will need to reference the internals directly. Only two aspects are worth mentioning explicitly:
The
GitHubFlavorextension which needs to be enabled explicitly by user code remains public for this purpose. It will move to a different package in a later milestone (e.g.laika.bundlewhich could host all built-in extensions).And secondly, removing the reStructuredText parser from public API means that this also includes the APIs for builing "rst-native" directives, which have a different syntax than Laika's own directives. These APIs have never been documented in the manual and it is generally recommended that developers use the more versatile Laika syntax which can be used for any markup format. The implementation must be kept simply to support the existing directives as defined in the rst spec.