Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken source links from hexdocs #231

Closed
nietaki opened this issue Dec 20, 2018 · 1 comment
Closed

Fix broken source links from hexdocs #231

nietaki opened this issue Dec 20, 2018 · 1 comment

Comments

@nietaki
Copy link

nietaki commented Dec 20, 2018

Currently the docs generate links based on a specific version/tag of the source, instead of master.

For example https://hexdocs.pm/hound/Hound.Helpers.Element.html#inner_text/1 links to https://github.com/HashNuke/hound/blob/1.0.4/lib/hound/helpers/element.ex#L31

The problem with that is, the recent releases either aren't tagged, or are tagged with vx.x.x instead of just x.x.x.

One solution would be to remove source_ref: "#{@version}" in mix.exs and make another release.

Another solution would be to add the missing tags and make adding them part of the release process.

I'd be happy to do it the latter way myself, but it would require push permissions to this repo, it might be easier if one of the maintainers does it.

@danhper
Copy link
Collaborator

danhper commented Mar 20, 2019

Thanks for catching this. This should now be fixed for the latest release.

@danhper danhper closed this as completed Mar 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants