Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add module header documentation #944

Open
perazz opened this issue Mar 6, 2025 · 4 comments
Open

Add module header documentation #944

perazz opened this issue Mar 6, 2025 · 4 comments
Labels
enhancement New feature or request idea Proposition of an idea and opening an issue to discuss it

Comments

@perazz
Copy link
Member

perazz commented Mar 6, 2025

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

@perazz perazz added enhancement New feature or request idea Proposition of an idea and opening an issue to discuss it labels Mar 6, 2025
@jvdp1
Copy link
Member

jvdp1 commented Mar 6, 2025

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??

@jalvesz
Copy link
Contributor

jalvesz commented Mar 6, 2025

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
Copy link
Member

jvdp1 commented Mar 7, 2025

Did one of you test Sourcery?

@perazz
Copy link
Member Author

perazz commented Mar 7, 2025

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

@perazz perazz marked this as a duplicate of #952 Mar 22, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request idea Proposition of an idea and opening an issue to discuss it
Projects
None yet
Development

No branches or pull requests

3 participants