calebjosue

calebjosue

Should not the links point to the latest version in the documentation?

I am reading (Once more) the Phoenix web framework documentation, in the From endpoint to views section contained in the Request life-cycle topic; The URL to the Plug documentation (The link is located in the second paragraph. [Plug] is a library and a specification…) right now is pointing to v1.16.1, should not the URL be updated to point to v1.18.1 instead?

I did not find (Doing a rather quick search) the repository to the documentation so I can propose a pull request.

Thanks.

Most Liked

rhcarvalho

rhcarvalho

The <> or </> symbol is often associated with “code”. The links are not necessarily to GitHub, it depends on the project configuration.

The documentation is written in Markdown format alongside the implementation of modules and functions.

The ex_doc library is the tool to extract the documentation and produce that nice website (and an ebook too!), and then it can publish the content to hexdocs.pm, a central repository of documentation.

You can also generate documentation for your own projects, even if you never intend to publish it online.


Now, why is it linking to version 1.16.1? I just checked, that is the version locked in phoenix/mix.lock at v1.8.1 · phoenixframework/phoenix · GitHub.

So I think ExDoc is interpreting Plug as a module and conservatively generating a link to the docs at the version the project has been tested with. I don’t know if that behavior is configurable.

kip

kip

ex_cldr Core Team

ex_doc is the doc generator for Elixir. it will do its best to form links for modules, functions, types and callbacks from the text within backticks. Thats how the docs are generated and how iex is able to introspect documentation too.

Last Post!

calebjosue

calebjosue

You are right, I happen to have some code on Bitbucket.
Thanks!

Where Next?

Popular in Proposals: Ideas Top

hst337
Elixir compiler and language specification Purpose of the proposal Elixir language is in mature state and no breaking or heavy changes ar...
New
c4710n
This is an idea for improving the workflow of iex -S mix phx.server The Problem and The Solution in use When running multiple Phoenix en...
New
rmoorman
Current situation Currently, the structure of the HTML returned by phoenix is determined by the layouts (components/layouts/[root,app].ht...
New
dkuku
This is a proposal to make the map key mismatch errors a bit better: Every time I have a typo It’s very challenging for me even when I u...
New
bartblast
This could resolve to {[a: 1, b: 2]}. Was it ever considered to allow such syntax? Notice this: {:abc, a: 1, b: 2} and this: my_fun(:abc,...
New
byhemechi
Many web frameworks (e.g. Remix, Gatsby) have an option for their link components that begins the navigation request on hover so that whe...
New
eagle-head
Hi everyone, I’ve been researching Content Security Policy Level 3 support in Phoenix and wanted to share my findings and a proposal for...
New

Other popular topics Top

rms.mrcs
Hi, I need to transform a list of numbers into a map where the keys are the indexes and the values are the original values of the list. ...
New
grych
Hi folks, Few months ago I have announced the proof-of-concept of the library to manipulate the browsers DOM objects directly from Elixi...
639 54006 488
New
vonH
When I run the Plug and I recompile I wind up having to use Ctrl C to quit iex and start again. Witht the help of rlwrap I can use the cu...
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
New

We're in Beta

About us Mission Statement