-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Artifacts stdlib manual does not document all exported functions #52688
Comments
Artifacts.jl came from Pkg.Artifacts. (#37320) |
The Pkg documentation uses these functions in example code in such a way that it implies these functions are part of the API. FYI, I am using select_downloadable_artifacts in a recent release of PkgToSoftwareBOM.jl and I would anticipate using artifacts_exists and artifact_path in the future. |
To be clear, these functions have docstrings, they are just not included in the manual (#19529). The only public symbol in Artifacts that is currently missing a docstring is the |
Fixes #52688 Co-authored-by: re1san <kathareaniket47@gmail.com>
The Artifacts stdlib exports the following functions:
But there is only documentation for
Since the other functions are exported, they are presumably part of the public API. In the Pkg documentation there is example code that uses all of these functions but the function documentation is missing.
I would request that the missing functions be added to the Artifacts documentation page.
The text was updated successfully, but these errors were encountered: