fireproofsocks
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!
Where Next?
Trending in Questions
Other Trending Topics
Latest on Elixir Forum
Sponsor Spotlight
Deploy Phoenix to your own VPS with PaaS ease: push-to-deploy, zero downtime, auto SSL, managed Postgres. 14-day free trial at potions.io
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
- #elixirconf
- #channels
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #blog-post
- #elixir-ls
- #ai
- #elixirconf-us
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #hex
- #security
- #metaprogramming
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.
Bringing learning, work and compliance together since 1987.
Enabling companies to succeed by building software people love.
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!"
Showing Posts 1 to 9- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
NobbZ
You can just
IO.puts @moduledoc.fireproofsocks
Digging around in the source code for
Mix.Tasks.Help, I can see that functions for this are not easily exposed.. for some reason, I’m having trouble calling the functions inIO.ANSI.Docs, e.g.What’s going on there?
fireproofsocks
Yeah, that’s what I’m doing so far, but it would be nicer to take advantage of the formatting.
josevalim
axelson
Also do note that
IO.ANSI.Docsis@moduledoc falsewhich means it is an internal implementation detail of Elixir and you should not be calling it from your code.https://github.com/elixir-lang/elixir/blob/da9b9014575c1930049235b0509657b2bde47319/lib/elixir/lib/io/ansi/docs.ex#L2
NobbZ
Not sure which sources you are digging, but at least on 1.10.2 I wasn’t able to find that function.
And as already has been said, the module is considered “private” and can change without notice.
fireproofsocks
I thought
@moduledoc falseonly indicated that documentation pages would not be generated. I do that on my own quickie projects where documentation isn’t necessary. It does not prevent me from calling the public functions in the module, however, so I am genuinely confused as to why I can’t call those functions.NobbZ
@moduledoc falseand@doc falseare 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.
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…