v3470

v3470

What about adding man page of built-in command to the docs

Or add corresponding explanatory links on the Guide page to make the documentation more complete and consistent?

Recently, I realized that I didn’t know where to look for the OPTIONS details for the iex command when the shell was unavailable. This may not be a problem for people already familiar with the basics, but when I tried to give a reference link for beginners, I found that neither the elixir-lang.org website nor the path /elixir and /iex of hexdocs.pm had the complete command-line usage. As a result, I had to refer to other third party sites like man.archlinux.org & manpages.ubuntu.com.

This is actually a minor annoyance if only for iex and mix two commands, but it is a little sad whenever I see “Documentation: https://elixir-lang.org/docs.html” at the bottom of the man page text.
Because you can’t find and jump to the docs of full CLI instructions for iex from the link, even using the DuckDuckGo search on the page’s right side with (site:elixir-lang.org|site:hexdocs.pm/elixir|site:hexdocs.pm/mix|site:hexdocs.pm/eex|site:hexdocs.pm/logger|site:hexdocs.pm/iex|site:hexdocs.pm/ex_unit) doesn’t help, and the best you can find is a few related info in Elixir Changelog :melting_face:.

Though I’ve considered the same kind of improvements could also be added to ex_doc (by giving it the option to include man pages at compile time), user-level scripts can be extended by using Mix.Tasks, which feel unnecessary when help information of the tasks already included.

8 years have passed since the man page content of iex was first committed, and the longer the subtle inconsistencies persist, the more unreasonable it becomes.

Personally, I don’t think the official documentation must contain a full copy with all existing man pages. However, when considering search engine indexing and website archiving (e.g. archive.org), it is really necessary to provide external links to the relevant missing information.

Since I don’t have permission to create a topic in the Suggestions & Proposals, I’m leaving this thread here for now. Besides, it’s almost 2024, there should be a more appropriate solution, :thinking:?

Where Next?

Popular in Discussions Top

chuck
Let me start by stating an assumption: Phoenix is a great approach to building REST APIs. There are many reasons for this, but I will ass...
New
AlexMcConnell
The reason that Rails is as popular as it is is because it’s very easy for relatively inexperienced developers to get a lot of work done....
588 19652 166
New
Crowdhailer
I’ve been hearing much about the new formatter and it’s something I have been keen to try. I find examples buy far the most illuminating...
248 19327 150
New
CharlesO
Erlang :list.nth simple, but 1 - based nth(1, [H|_]) -> H; nth(N, [_|T]) when N > 1 -> nth(N - 1, T). Elixir Enum.at … coo...
New
sergio
There’s a new TIOBE index report that came out that shows Elixir is still not in the top 50 used languages. It also goes on to call Elix...
New
klo
Got a question about when to concat vs. prepending items to list then reversing to achieve appending. So i know lists boil down to [1 | ...
New
cblavier
Hey there, It’s been more than a year since we started using LiveView as our main UI library and building a whole library of UI componen...
New
100phlecs
Are there any downsides, like perf issues, to putting all functional components in CoreComponents as long as you prefix it with the conte...
New
sashaafm
Piggy backing a bit on @dvcrn topic BEAM optimization for functions with static return type?, I’ve been trying to understand in a deeper ...
New
Markusxmr
Since Drab has been developed for a while in the open, introducing the Liveview functionality in a way it happend appears to undermine th...
New

Other popular topics Top

WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
baxterw3b
Hi guys, i’m new in the Elixir world, and i have to say, that i love it! i’m having some problem to understand anonymous functions with ...
New
pmjoe
I have a relationship of love and hate with Elixir. Lots of things are just absolutely right, but there are some things that are kind of ...
New
nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
KronicDeth
Elixir plugin for JetBrain’s IntelliJ Platform (including Rubymine) This is a plugin that adds support for Elixir to JetBrains IntelliJ...
289 36352 110
New
Brian
What is the proper way to load a module from a file in to IEX? In the python world, doing something like this pretty standard: from ....
New
AstonJ
We’ve put together this wiki for Phoenix LiveView - please feel free to add any info you feel is worth including. What is Phoenix LiveV...
New
JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 54120 245
New
sergio
Kind of like when jquery came out, it was super necessary. Existing drag and drop libraries have a bunch of baggage to support old browse...
New

Latest on Elixir Forum

Elixir Forum

We're in Beta

About us Mission Statement