You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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).
The text was updated successfully, but these errors were encountered:
ccamel
changed the title
Add check to avoid 'undefined' in generated documentation
📐 Add check to avoid 'undefined' in generated documentation
Sep 7, 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.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).
The text was updated successfully, but these errors were encountered: