Nested defmodule about elixir_style_guide HOT 5 CLOSED

Nested modules are not that common, so it's hard to say if there's an accepted style. In general, they would be well-placed after any defstruct and any @type definitions, but before the parent module's functions.

Here's an example from the standard library: https://github.com/elixir-lang/elixir/blob/9b6ec7bae79ececfb9ed481c780febb6a5b293e8/lib/elixir/lib/version.ex#L109

from elixir_style_guide.

Sounds fine to me!

I use it a lot for structs but I notice a project like HTTPoison defines them in the same file but outside of the module. Do you think that style is more common? I assume not so much that it should be recommended in the style guide instead of nesting.

Please let me know if I should submit a PR with the nested defmodule addition.

from elixir_style_guide.

This guide has already settled on a preference for one module per file, which would suggest nesting modules rather than defining them one after the other as HTTPoison does.

It's hard to recommend a precise location for nested defmodule since there aren't many examples to go on. We can agree it should go after defstruct but before any functions. If forced to choose, I would include it in item xiii, as "defmacro, defmodule, defguard, def, etc." and place defmodule after defmacro, since everything above that seems more like the module's preamble, and everything after that the real working code.

What do you think?

from elixir_style_guide.

Sounds reasonable 👍

from elixir_style_guide.

A PR would be welcome on this!

from elixir_style_guide.