Restore warning on missing references and .html link (for .md)
#1798
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
lib/ex_doc/language/elixir.ex
Outdated
| defp custom_link(attrs, config) do | ||
| def custom_link(attrs, config) do |
There was a problem hiding this comment.
This is the function I mention in the description. Where to put it, and the code it depends on?
There was a problem hiding this comment.
You can put it in the ExDoc.Autolink module :)
There was a problem hiding this comment.
Got it, thanks. I'll move it, and the code it depends on, to that one.
There was a problem hiding this comment.
1. identify function to move over: "custom_link/2" 2. copy-paste, from elixir.ex, then remove it there 3. save, format and mix test 4. got warnings, solved those, identified new function 5. rinse and repeat from 2-4 until no more warnings Finally, "Autolink." was removed from autolink.ex erlang.ex was adapted to use the newly exposed function Tests are as-were (no failures, locally) There are no compilation warnings, locally
josevalim
approved these changes
Oct 29, 2023
|
Thank you! |
paulo-ferraz-oliveira
deleted the
fix/md-links-and-missing-link-warnings
branch
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.
While 9579ce8 (from #1617) added features to
ex_doc, it also stopped using hardcoded languageElixir, which seems to have had the unintended consequence of removing other features, like:warning: documentation references file "examples" but it does not exist), and.mdto.html(links aren't "transformed"), e.g. as per usingrebar3_ex_doc.I found the commit by
git bisect'ing, and it helped me understand where the origin of the issue was.This pr is just an initial step as I understand you might not want the Erlang handler calling the Elixir handler, but:
I did copy the tests over from the Elixir counterpart, though, as that seemed to make sense (same requirements, I guess).