Adding documentation comments#24
Conversation
aaumar25
left a comment
aaumar25
left a comment
There was a problem hiding this comment.
I will copy from other PR comments as the issue is the same.
Remember that PR title must be useful for users as the title will be used for generating release notes. refactor shall not be in the PR title as it is not useful for users. It is only useful for us, developer, thus it should only be contained in the commit title.
In addition, please refrain from abbreviating words in PR title. Also, pay attention on where and when to capitalize letter.
I have nothing to add regarding the changed files, everything looks good! Once you edit the PR title, you can merge it by yourself!
| try walkFields(@This(), ""); | ||
| } | ||
|
|
||
| /// Provides metadata for the field, including its type, description, |
There was a problem hiding this comment.
| /// Provides metadata for the field, including its type, description, | |
| /// Provide field type of config fields and its metadata. |
The only important description is the Drivercom.Config.Info is actually just a metadata for config fields. What kind of metadata given is not important to be written for Drivercom.Config.Info doc comments as it is clearly written in Drivercom.Config.Info.Meta. Maybe we can some information as well that the metadata of a field is given with prefix double underscore.
solara404
changed the title
2 participants
added doc comment to Config.zig Info struct