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

Artifacts stdlib manual does not document all exported functions #52688

Closed
SamuraiAku opened this issue Jan 1, 2024 · 4 comments · Fixed by #52698
Closed

Artifacts stdlib manual does not document all exported functions #52688

SamuraiAku opened this issue Jan 1, 2024 · 4 comments · Fixed by #52698
Labels
docs This change adds or pertains to documentation stdlib Julia's standard library

Comments

@SamuraiAku
Copy link
Contributor

The Artifacts stdlib exports the following functions:

  • artifact_exists
  • artifact_path
  • artifact_meta
  • artifact_hash
  • select_downloadable_artifacts
  • find_artifacts_toml
  • @artifact_str

But there is only documentation for

  • artifact_meta
  • artifact_hash
  • find_artifacts_toml
  • @artifact_str

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.

@inkydragon inkydragon added docs This change adds or pertains to documentation stdlib Julia's standard library labels Jan 1, 2024
@inkydragon
Copy link
Member

Since the other functions are exported

Artifacts.jl came from Pkg.Artifacts. (#37320)
It used to be a submodule.
So maybe the functions should not be exported? @staticfloat

https://github.com/JuliaLang/Pkg.jl/blob/3c86ba27e904807e13beb8cb0466ed70365b0b2d/src/Artifacts.jl#L16-L19

@SamuraiAku
Copy link
Contributor Author

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.

@nsajko
Copy link
Contributor

nsajko commented Jan 4, 2024

Seems to duplicate issue #31202. Also related: #19529, #51335.

@stevengj
Copy link
Member

stevengj commented Jan 4, 2024

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 Artifacts module itself.

@SamuraiAku SamuraiAku changed the title Artifacts stdlib documentation does not document all exported functions Artifacts stdlib manual does not document all exported functions Jan 6, 2024
vtjnash pushed a commit that referenced this issue Feb 7, 2024
Fixes #52688

Co-authored-by: re1san <kathareaniket47@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation stdlib Julia's standard library
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants