Only use shell_docs for html docs (OTP26-) #13583
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
|
I think this is what we want for now. We may go back to Erlang+HTML, but only once we are on OTP 27+. |
josevalim
reviewed
May 21, 2024
| @@ -259,7 +259,7 @@ defmodule IEx.Introspection do | |||
| case Code.ensure_loaded(module) do | |||
| {:module, _} -> | |||
| case Code.fetch_docs(module) do | |||
| {:docs_v1, _, :erlang, _, _, _, _} = erl_docs -> | |||
| {:docs_v1, _, :erlang, "application/erlang+html", _, _, _} = erl_docs -> | |||
There was a problem hiding this comment.
We should add a TODO to remove support for "application/erlang+html" once we are on OTP 27+.
josevalim
approved these changes
May 21, 2024
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.
Approach 1 for discussion - only use shell docs for OTP26-, and use the new markdown + existing IO.ANSI.Docs markdown.
Will bring back specs, supports tables & skips mermaid charts.
Still need to fix tests.