#Group functions by concerns in Gleam Docs

1 messages · Page 1 of 1 (latest)

versed crow
#

Hi, is there any way to group the functions by concerns in Gleam Docs ? Right now, it's a little hard to have all the functions with no separations if you have a lot of functions in the same module. Example in screens 😅

#

Unfortunately, I cloud split the functions in another file, but I'd prefer to have everything in the same place (easier to import)
(Yay CSS with like 10K keywords 😆 )

inland drift
#

Gleams docs are always an alphabetical api reference. Our convention in gleam-community is to provide a table of contents in the module docs that organise things how we want

versed crow
#

OK, thanks for the answer!

coral frigate
#

This is something I would like in some opt-in way, but I don't know what the API should be

versed crow
#

Yes, I was thinking a little bit more and it feels really hard to find a correct API for it. Maybe by reusing the //// directives? Or to group functions with an @docs(section)?

coral frigate
#

Yeah I'm not sure really

#

An attribute could be good

thick shoal
#

This would be really nice. I'm finding I re-implement functions that already exist because there are no signatures in the hexdocs "functions" list, and they are not grouped by input or output type.

lusty trellis
#

wasn't someone working on a site to search functions by type? across packages, that is.