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

Create script to check correctness of docblocks #113

Open
belsrc opened this issue Dec 2, 2024 · 0 comments · May be fixed by #106
Open

Create script to check correctness of docblocks #113

belsrc opened this issue Dec 2, 2024 · 0 comments · May be fixed by #106
Assignees
Labels
chore Other changes that don't modify source or test files ci Changes to our CI configuration files and scripts setup Repo setup and architecture

Comments

@belsrc
Copy link
Contributor

belsrc commented Dec 2, 2024

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

@belsrc belsrc linked a pull request Dec 2, 2024 that will close this issue
7 tasks
@belsrc belsrc added chore Other changes that don't modify source or test files ci Changes to our CI configuration files and scripts setup Repo setup and architecture labels Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Other changes that don't modify source or test files ci Changes to our CI configuration files and scripts setup Repo setup and architecture
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants