- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 5.7k
Add basic docs for (Lazy)Artifacts stdlibs #39073
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
          
     Merged
      
      
    
  
     Merged
                    Changes from all commits
      Commits
    
    
  File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Artifacts | ||
|  | ||
| ```@meta | ||
| DocTestSetup = :(using Artifacts) | ||
| ``` | ||
|  | ||
| Starting with Julia 1.6, the artifacts support has moved from `Pkg.jl` to Julia itself. | ||
| Until proper documentation can be added here, you can learn more about artifacts in the | ||
| `Pkg.jl` manual at <https://julialang.github.io/Pkg.jl/v1/artifacts/>. | ||
|  | ||
| !!! compat "Julia 1.6" | ||
| Julia's artifacts API requires at least Julia 1.6. In Julia | ||
| versions 1.3 to 1.5, you can use `Pkg.Artifacts` instead. | ||
|  | ||
|  | ||
| ```@docs | ||
| Artifacts.artifact_meta | ||
| Artifacts.artifact_hash | ||
| Artifacts.find_artifacts_toml | ||
| Artifacts.@artifact_str | ||
| ``` | ||
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Lazy Artifacts | ||
|  | ||
| ```@meta | ||
| DocTestSetup = :(using LazyArtifacts) | ||
| ``` | ||
|  | ||
| In order for a package to download artifacts lazily, `LazyArtifacts` must be | ||
| explicitly listed as a dependency of that package. | ||
|  | ||
| For further information on artifacts, see [Artifacts](@ref). | 
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW in case anybody wonders why these four functions and not others: I took the Artifacts API reference in the Pkg.jl documentation and extracted all functions from there which also are in Artifacts.jl, and put them in the above list. That seemed safest: these are functions somebody already decided should appear in a public manual. I think there are a few with docstrings which should not appear here (they are rather about implementation details), but perhaps a few more should appear? In any case, I rather don't want to be the person to decide that; but I'll happily add more here if people request it.