fireproofsocks
Show help in custom mix task
I understand that the @moduledoc text is what gets shown when you type in mix help your.task:
Is there a way to show that information manually? For example, if my task has some required arguments or options, it’s possible to show an error using something like Mix.shell().error("Invalid input.), but I think it would be nicer in some cases to print out the usage info (just like you might encounter when you misuse a linux utility on the command line).
Thanks!
Marked As Solved
josevalim
Also Liked
NobbZ
@moduledoc false and @doc false are conventions for internally used functions that need to be exposed because they are used through the project, but are also not part of the public interface of the library.
The reason why you can’t call the function, is because the source code you looked at does probably not match the elixir version you have installed.
This is the reason why the module is marked “internal”, this gives the core team the flexibility to change it as necessary without needing to think about backwards compatibility.
axelson
Also do note that IO.ANSI.Docs is @moduledoc false which means it is an internal implementation detail of Elixir and you should not be calling it from your code.
Last Post!
fireproofsocks
Yeah, I’m looking at the latest master branch of the Elixir source… that must be different than the 1.10.1 code that I am actually running…
Popular in Questions
Other popular topics
Latest on Elixir Forum
Sponsor Spotlight
Catch errors, track performance, monitor hosts and more.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #elixirconf-us
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #metaprogramming
- #security
- #hex
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Practical resources that improve the lives of professional developers.
Develop your skills with books, videos, and courses.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"