Skip to content

Add module header documentation #944

@perazz

Description

@perazz
Member

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

Activity

added
enhancementNew feature or request
ideaProposition of an idea and opening an issue to discuss it
on Mar 6, 2025
jvdp1

jvdp1 commented on Mar 6, 2025

@jvdp1
Member

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

jalvesz commented on Mar 6, 2025

@jalvesz
Contributor

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

jvdp1 commented on Mar 7, 2025

@jvdp1
Member

Did one of you test Sourcery?

perazz

perazz commented on Mar 7, 2025

@perazz
MemberAuthor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestideaProposition of an idea and opening an issue to discuss it

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @perazz@jvdp1@jalvesz

        Issue actions

          Add module header documentation · Issue #944 · fortran-lang/stdlib