Questions & Help>Questions

A tool to check documentation of functions?

#tools#documentation
lud

lud

A tool to check documentation of functions?

Hello,

I am looking for a tool to report all exported functions with missing @doc in a project.

So far I have found:

  • Inch - I have not been able to use it since several Elixir minor versions.
  • Credo - It is useful for many things and missing @spec but I am not sure if there is a way to report missing @doc attributes. Maybe that could be a proposal.
  • Doctor - It does not report what functions are missing, and reports functions even it there is @moduledoc false in the module, which does not work quite well with my workflow.

Does anyone knows another tool that could do what I want?

Bonus point if it reports missing @doc on @callback declarations!.

Otherwise I will see if a custom credo check is possible…

7 comments
#tools
9 150 7

Most Liked

lud

lud

I updated the issue on the credo repo. If a macro-aware way was found for moduledocs it can be done for doc as well I guess.

3
Post #8
slouchpie

slouchpie

I am AFK but 99% sure credo has this.

1
Post #2
sbuttgereit

sbuttgereit

I’m looking at the docs now. I see it for moduledocs:

https://hexdocs.pm/credo/Credo.Check.Readability.ModuleDoc.html#content

But I don’t see it for other kinds of documentation. I could just be missing it or it could be under a name I’m not expecting.

1
Post #3
slouchpie

slouchpie

I was wrong. It is not available in credo. Proposal: Have a check for undocumented Public functions · Issue #18 · rrrene/credo-proposals · GitHub

Sorry for the noise.

1
Post #5
D4no0

D4no0

I know that a lot of folk build their own custom credo checks, maybe you could do that too.

Here is a official guideline from credo repo on how to build your own custom check: credo/guides/custom_checks/adding_checks.md at master · rrrene/credo · GitHub

1
Post #6

Where Next?

View thread on forum (has 7 responses!)
tools
documentation
Home Questions & Help>Questions
#tools#documentation
9 152 7
Last post

Popular in Questions Top

lastday4you
Questions & Help>Questions

How to check Elixir version
I wanted to check elixir version in phoenix because i found that my elixir is 1.5 but when i use Enum.chunk_by it said the function is un...
#how-to-question
11 18647 3
New
joaquinalcerro
Questions & Help>Questions

What is the best approach for fetching large amount of records from postgresql with ecto
Hi there, I am working with Ecto-Postgresql and I need to call all of the records from a specific table but the table has 40,000 record...
#ecto
126 24587 27
New
openscript
Questions & Help>Questions

How to set up the Elixir SDK in Intellij IDEA with the intellij-elixir plugin?
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
17 22671 9
New
_russellb
Questions & Help>Questions

Web scraping tools
I want to try my hand at web scraping. What tools/libraries do I need to use. I’m hoping to turn this into something professional so don’...
#web-scraping
123 19127 45
New
Jim
Questions & Help>Questions

Help with HTTPoison POST
As a follow up to my earlier question: I have the code compiling and running but not getting a successful login from the rest server. ...
#troubleshooting
15 14640 7
New
qwerescape
Questions & Help>Questions

How to get the call stack/stack trace at any point in code?
Is there a way to get the call stack or stack trace at any point in the code? Not from exceptions, but an expression that returns how the...
53 15772 4
New
stefanluptak
Questions & Help>Questions

Using VSCode on multiple monitors
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
#vscode#vscode-elixir
7 17615 6
New
fireproofsocks
Questions & Help>Questions

Ecto delete a record WITHOUT selecting first
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? https://hexdocs.pm/ecto/Ecto.Repo.h...
#ecto#optimization#delete-method
22 16810 8
New
Codball
Questions & Help>Questions

Mix format on save VSCode
Mix format works fine if run from the cmd. I’ve followed this to facilitate the implementation into VSC which involves downloading an ext...
#mix
29 13345 4
New
skosch
Questions & Help>Questions

Put/update deep inside nested maps (and auto-create intermediate keys)
To my knowledge, put_in, Map.update etc. all have the one limitation of not automatically creating intermediate keys when needed (for exa...
#data-structures#maps#immutability
52 20047 11
New

Other popular topics Top

Patoshizzle
Questions & Help>Questions

(Postgrex.Error) FATAL 28P01 (invalid_password) password authentication failed for user “postgres”
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID<0.412.0> terminating ** (Postgrex.Error) FATAL...
#ecto#postgres#troubleshooting
10 28696 20
New
Tee
Questions & Help>Questions

Enumerables - how does Enum.reduce work with maps
can someone please explain to me how Enum.reduce works with maps
#erlang
18 14675 13
New
vonH
Questions & Help>Questions

Why would I choose Elixir as a general purpose programming language?
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
#functional-programming#use-cases
65 34758 13
New
gshaw
Questions & Help>Questions

Idiomatic guard clause for checking not nil
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...
#guard-clauses
13 43178 3
New
yawaramin
Questions & Help>Questions

Dialyzer: suppress warning on a specific function
In the Dialyzer docs ( http://erlang.org/doc/man/dialyzer.html#requesting-or-suppressing-warnings-in-source-files ), there is a way to tu...
#dialyzer
25 13690 6
New
sergio
Learning Resources>Guides/Tuts/Tips/Info

Phoenix 1.6.0 LiveView + esbuild + Tailwind JIT + AlpineJS - A brief tutorial
I couldn’t find any guides that worked well with Phoenix 1.6.0 and esbuild. I hope this helps people test the waters and eases you into t...
/phoenix#liveview
137 17627 35
New
vertexbuffer
Questions & Help>Questions

Deleting item from a list
Hello, can anybody help here..? I have a list of players and I what to delete an element, but every for loop the list is reverting to ori...
7 24097 4
New
shahryarjb
Questions & Help>Questions

How to convert map to string (separated with ,)
Hello, I have map which I want to convert it to string like this: the map: %{last_name: "tavakkoli", name: "shahryar"} the string I ne...
#maps#strings
15 15491 2
New
msaraiva
Your Libraries & Projects>Libraries

Surface - A component-based library for Phoenix LiveView
Surface is an experimental library built on top of Phoenix LiveView and its new LiveComponent API that aims to provide a more declarative...
/phoenix#liveview#livecomponents#surface
564 42633 214
New
lucidguppy
Questions & Help>Questions

How do I read a file and enumerate its lines
I have a super simple question about elixir - how would I take a file like this foo bar baz and output a new file that enumerates th...
#how-to-question
20 15454 3
New
Back to top

Questions & Help>Questions

Questions Questions ❯

Latest on Elixir Forum

Elixir Forum ❯

Sponsor Spotlight

Potions

The deployment platform built for Elixir: PaaS ease, VPS control.

Our Sponsors

Dashbit

Build Elixir applications with speed and confidence.

EEF

Supporting innovation across the BEAM ecosystem.

Coders51

We build reliable cloud platforms for business-critical systems.

AppSignal

Catch errors, track performance, monitor hosts and more.

Pragmatic Bookshelf

Practical resources that improve the lives of professional developers.

WyewWorks

Enabling companies to succeed by building software people love.

Potions

The deployment platform built for Elixir: PaaS ease, VPS control.

Pragmatic Studio

Courses that'll move you from confusion to "Aha, now I get it!"

View all our sponsors ❯

Categories:

Sub Categories:

Forums

Our Sponsors

Dashbit

Build Elixir applications with speed and confidence.

EEF

Supporting innovation across the BEAM ecosystem.

Coders51

We build reliable cloud platforms for business-critical systems.

AppSignal

Catch errors, track performance, monitor hosts and more.

Pragmatic Bookshelf

Practical resources that improve the lives of professional developers.

WyewWorks

Enabling companies to succeed by building software people love.

Potions

The deployment platform built for Elixir: PaaS ease, VPS control.

Pragmatic Studio

Courses that'll move you from confusion to "Aha, now I get it!"

View all our sponsors ❯

We're in Beta

About us Mission Statement