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

Warn if the package module is missing a docstring #35

Open
DilumAluthge opened this issue Mar 20, 2021 · 2 comments
Open

Warn if the package module is missing a docstring #35

DilumAluthge opened this issue Mar 20, 2021 · 2 comments

Comments

@DilumAluthge
Copy link
Member

Copying from https://github.com/JuliaRegistries/RegistryHealthChecks.jl/issues/2


If a module is missing a docstring and a user tries help?> Package, currently nothing shows. JuliaLang/julia#39093 aims to print the README contents

But, it would be good to promote the addition of carefully crafted docstrings for the main module in the package, as they would likely be better crafted for purpose.

Could the merge bot warn if there isn't one?
Perhaps there are other best-practices to check for too?

@DilumAluthge
Copy link
Member Author

cc: @IanButterworth

@giordano
Copy link
Member

One problem is that at the moment we don't parse nor run the code of the package. In particular, we don't want to install it, nor pull all of its dependencies, Pkg isn't involved at all here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants