only Text and HTML *exports* should be deprecated#43532
Merged
JeffBezanson merged 2 commits intomasterfrom Jan 6, 2022
Merged
Conversation
LilithHafner
pushed a commit
to LilithHafner/julia
that referenced
this pull request
Feb 22, 2022
LilithHafner
pushed a commit
to LilithHafner/julia
that referenced
this pull request
Mar 8, 2022
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
#38909 added a deprecation warning for the
HTMLandTextexports. However, I think that PR went too far in recommending that these types "should not be used", because there is no alternative type toText(e.g. for plain-text documentation, which can easily arise from non-Julia API docs, such as in PyCall).Instead, I think we should merely recommend that people use
Docs.TextandDocs.HTML, or import these symbols explicitly fromDocs, rather than relying on the exports. This paves the way for removing the exports in 2.0 (which can easily conflict with other types since the names are so generic), while making it clear that they are still usable for the narrow purpose of text/plain and text/html documentation.