Create script to check correctness of docblocks #113
Description
Provide a general summary of the feature
Create a script that we can then tie into Turbo and CI pipeline that would check the code for an individual package and inform the developer whether or not all publicly exposed items have a well structured docblock.
🤔 Expected Behavior?
The script should run on the all of the code files in a package. It could also respect the // @export-* comments that will come with the indexer CLI. It should make sure that the docblock has a minimum of a description and at least one @example. @param and @return are not needed as the types themselves should cover it. Unless they are particularly complex.
😢 Current Behavior
No response
🤩 Possible Solution
No response
📜 Context
More automation and better resulting documentation.
💻 Examples
No response