Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

📐 Add check to avoid 'undefined' in generated documentation #323

Open
ccamel opened this issue Aug 23, 2023 · 0 comments
Open

📐 Add check to avoid 'undefined' in generated documentation #323

ccamel opened this issue Aug 23, 2023 · 0 comments
Assignees

Comments

@ccamel
Copy link
Member

ccamel commented Aug 23, 2023

Purpose

The documentation we produce (thanks to fadroma/schema - #311) relies on a specific format of comments. For instance, if types aren't correctly described in the comments of the source code, they'll appear as undefined in the documentation.

image

Todo

To maintain documentation quality, we should integrate a check process that ensures no undefined definitions are present in the committed documentation.

There are several ways of doing this, but it could be an additional control step in the makefile when generating the documentation (which will also be used in the CI).

@ccamel ccamel changed the title Add check to avoid 'undefined' in generated documentation 📐 Add check to avoid 'undefined' in generated documentation Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants