PackageAnalyzer.jl icon indicating copy to clipboard operation
PackageAnalyzer.jl copied to clipboard

Published 20 hours ago • verified publisher icon JuliaEcosystem

Warn if the package module is missing a docstring

Open DilumAluthge opened this issue 3 years ago • 2 comments

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. https://github.com/JuliaLang/julia/pull/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 avatar Mar 20 '21 19:03 DilumAluthge