Formatting elixir, especially docs | Elixir Language | Page 1

placid pendant Sep 23, 2023, 10:00 AM

#

I was looking at the Kino source code and noticed, that the docs are nicely formatted ending at 60 chars per line.
What tooling achieves this? The project does not have a dialyzer task and mix format does not change anything for me.

here an example of neatly formatted docs:

  @doc """
  Creates a new select input.

  The input expects a list of options in the form `[{value, label}]`,
  where `value` is an arbitrary term and `label` is a descriptive
  string.

  ## Options

    * `:default` - the initial input value. Defaults to the first
      value from the given list of options

  ## Examples

      Kino.Input.select("Language", [en: "English", fr: "Français"])

      Kino.Input.select("Language", [{1, "One"}, {2, "Two"}, {3, "Three"}])
  """

What are the best practices here and what is the easiest way to easily format the docs?

#

i found a discussion about this in the elixir forum: https://elixirforum.com/t/mix-format-doesnt-format-docs/13465/6

it looks like this is an open discussion, can anyone confirm?

Elixir Programming Language Forum

Mix format doesn't format docs

Do you have a code snippet we can look at? Maybe show what you have now and how you’d prefer the formatter to format it.

violet spindle Sep 23, 2023, 10:17 AM

#

the last post there summarizes it, altering strings like doc strings would alter the AST and the formatter won't do that AFAIK

#

so I don't think this is a feature that is being planned for the builtin formatter

placid pendant Sep 23, 2023, 10:44 AM

#

violet spindle the last post there summarizes it, altering strings like doc strings would alter...

ok, thanks,
i was wondering if there were any other tools for that, that i am not aware of. I just looked to neat to me to be formatted completely manually 😄

#Formatting elixir, especially docs