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.
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
@moduledocblock. If not, the system should either provide a warning or automatically format the response accordingly.Describe alternatives you've considered
Additional context
Ensuring proper
@moduledocformatting enhances readability, maintainability, and consistency in documentation across the project.