fortran-lang/stdlib

Add module header documentation

perazz opened this issue ยท 4 comments

Description

Most of the modules and submodules do not appear to be properly documented and their FORD summary appears to be empty:

https://stdlib.fortran-lang.org/lists/files.html

I believe it is sometimes due to lack of documentation, and sometimes failure to capture the module header syntax (!> or !!).

Expected Behaviour

It would be great to see improvements in how module headers are described in the docs site.

Version of stdlib

0.7.0

Platform and Architecture

all

Additional Information

No response

jvdp1 commented

It would be great to see improvements in how module headers are described in the docs site.

I fully agree with you. Maybe it is a task for a LLM or some bots checking that in the CI??

After seen the publication about fortitude I thought that it could be possible to add pre-commit + fortitude in the CI in order to help with that. I don't know if it could be coupled with co-pilot in order to achieve an agentic LLM full review process?

jvdp1 commented

Did one of you test Sourcery?

Never used it myself but I've seen it around - basically an LLM bot that does most of the review on your behalf?