Misc doc changes #2
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
Besides other documentation changes, this commit ensures the generated HTML doc for HexDocs.pm will become the source of truth for this Elixir library and leverage on latest features of ExDoc.
Closed
bmuller
reviewed
Sep 26, 2021
bmuller
reviewed
Sep 26, 2021
mix.exs
Outdated
| defp deps do | ||
| [ | ||
| {:credo, "~> 1.5", only: [:dev, :test], runtime: false}, | ||
| {:ex_doc, "~> 0.25", only: :dev} | ||
| {:ex_doc, ">= 0.0.0", only: :dev, runtime: false} |
There was a problem hiding this comment.
Let's go with a recent ex_doc requirement (at least 0.24, if not 0.25). I don't want to promise users that version 0.5.1 from 2014 will work, for instance - I have no idea if that's true.
|
Thanks @kianmeng! Just 2 small changes I'd like to request - otherwise looks great. Thanks for making this project better! |
|
@bmuller Done. Please check again. |
bmuller
reviewed
Oct 4, 2021
bmuller
reviewed
Oct 10, 2021
mix.lock
Outdated
| "earmark_parser": {:hex, :earmark_parser, "1.4.15", "b29e8e729f4aa4a00436580dcc2c9c5c51890613457c193cc8525c388ccb2f06", [:mix], [], "hexpm", "044523d6438ea19c1b8ec877ec221b008661d3c27e3b848f4c879f500421ca5c"}, | ||
| "ex_doc": {:hex, :ex_doc, "0.25.2", "4f1cae793c4d132e06674b282f1d9ea3bf409bcca027ddb2fe177c4eed6a253f", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "5b0c172e87ac27f14dfd152d52a145238ec71a95efbf29849550278c58a393d6"}, | ||
| "ex_doc": {:hex, :ex_doc, "0.24.2", "e4c26603830c1a2286dae45f4412a4d1980e1e89dc779fcd0181ed1d5a05c8d9", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "e134e1d9e821b8d9e4244687fb2ace58d479b67b282de5158333b0d57c6fb7da"}, |
There was a problem hiding this comment.
Hey @kianmeng - Why the downgrade to ex_doc? I think this file can just be reverted.
This is the last item - otherwise I'm ready to merge. Thanks again for your help!
kianmeng
force-pushed
the
misc-doc-changes
branch
from
54b8f9c
to
9cc43ac
Compare
|
@bmuller Requested changes done. Thanks. |
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.
Besides other documentation changes, this commit ensures the generated
HTML doc for HexDocs.pm will become the source of truth for this Elixir
library and leverage on latest features of ExDoc.