search

ueberauth / guardian

Elixir Authentication
MIT License
3.43k stars 382 forks source link

Fix links and formatting #560

Closed toraritte closed 5 years ago

toraritte commented 5 years ago

Did a minor re-phrasing of the first paragraph at ## Pipelines.

codecov-io commented 5 years ago

Codecov Report

Merging #560 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #560   +/-   ##
=======================================
  Coverage   85.37%   85.37%           
=======================================
  Files          18       18           
  Lines         417      417           
=======================================
  Hits          356      356           
  Misses         61       61

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 442b6f5...da39cff. Read the comment docs.

yordis commented 5 years ago

The links are not broken, they work when you use ex_doc (official documentation tool for Elixir).

They are not meant to work as how Github links markdown files together.

Either go to the online documentation or do mix docs from this repo which will generate the documentation for you.

doomspork commented 5 years ago

@yordis / @toraritte should we add a note to the README about generating the documentation for future users?

yordis commented 5 years ago

@doomspork I would, I can't count how many times I have to explain this 😄 , but I would say that maybe Elixir itself should invest a little bit more in clarifying these things, but we do not have control of it.