Suggestion: Doc comments for modules

[Spatenheinz]

With the Justfiles (in v. 1.29.1):

# Justfile
# recipes for foo'ing
mod foo

# foo.just
bar:
  echo "foobar"

calling just --list gives:

Available recipes:
    foo ...

It would be great if modules has doc comments similar to recipes.

Available recipes:
    foo ...  # recipes for foo'ing

[casey]

I think this would be great. The relevant code is here. There's already a function for getting the last doc comment, which is used to get recipe doc comments. All that's needed is to add a comment field to Item::Module, populate it by calling pop_doc_comment when parsing, and it through to the parsed Justfile, and display it in --list.

[Spatenheinz]

I will get to it then :D

[laniakea64]

Comment style doc for modules works for me, but [doc] attribute style doesn't work? :confused:

[doc("Foo.")]
mod j

$ just --unstable --list
error: Expected '*', ':', '$', '=', identifier, or '+', but found end of line
 ——▶ justfile:2:6
  │
2 │ mod j
  │      ^

[casey]

The [doc(…)] syntax hasn't been implemented yet, I opened #2207 to track it.