Skip to content

Check if the response is in @moduledoc format #18

Description

@0xCAB0

Is your feature request related to a problem? Please describe.
Currently, there is no automatic validation to ensure that documentation responses are properly formatted using @moduledoc. This can lead to inconsistent or missing module-level documentation.

Describe the solution you'd like
Implement a simple check to verify if the response is correctly formatted within an @moduledoc block. If not, the system should either provide a warning or automatically format the response accordingly.

Describe alternatives you've considered

  • Manually reviewing module documentation, which is error-prone.
  • Using external linting tools, but integrating the check directly would be more efficient.

Additional context
Ensuring proper @moduledoc formatting enhances readability, maintainability, and consistency in documentation across the project.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions