Skip to content

Link to module without doc is rendered to hex doc #1014

@chulkilee

Description

@chulkilee

I have an umbrella project with apps and extra markdown file (passing it in extras option).

In the extra markdown file, I referred Db.Repo.init/2, Db.Post and Ecto.Repo. And I put @moduledoc false to Db.Repo module.

Results are:

  • correct: Ecto.Repo => a link to hexdocs page with version (probably in the mix.lock)
  • correct: Db.Post => a link to Db.Package.html
  • incorrect: Db.Repo.init/2 is rendered as a link to hexdocs page with db package with umbrella app version - i.e. https://hexdocs.pm/db/0.0.1/Db.Repo.html#init/2

Environment:

  • ex_doc: 0.20.2
  • Elixir: 1.8.2

Expected result:

Do not make a link if module/func has doc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions