Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ericphanson committed Jul 7, 2024
1 parent 5dd8ca2 commit 469d0a4
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions src/AutoMerge/util.jl
Original file line number Diff line number Diff line change
Expand Up @@ -288,9 +288,18 @@ end

"""
get_all_non_jll_package_names(registry_dir::AbstractString) -> Vector{String}
get_all_non_jll_package_names(registry::RegistryInstance) -> Vector{String}
Given a path to the TOML file or directory holding a registry, returns the names of all the non-JLL packages
defined in that registry, along with the names of Julia's standard libraries.
Given either:
- a path to a directory holding an uncompressed registry
or
- a `RegistryInstance` object (from [RegistryInstances.jl](https://github.com/GunnarFarneback/RegistryInstances.jl)) associated to a registry,
returns a sorted list of the names of Julia's standard libraries
and all the non-JLL packages defined in that registry.
"""
function get_all_non_jll_package_names(registry_dir::AbstractString)
registry = (; pkgs=TOML.parsefile(joinpath(registry_dir, "Registry.toml"))["packages"])
Expand Down

0 comments on commit 469d0a4

Please sign in to comment.