From 469d0a45f520a5d5bcf8c1e02711b38b41d5bb16 Mon Sep 17 00:00:00 2001
From: Eric Hanson <5846501+ericphanson@users.noreply.github.com>
Date: Sun, 7 Jul 2024 16:17:31 +0200
Subject: [PATCH] update docstring

---
 src/AutoMerge/util.jl | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/src/AutoMerge/util.jl b/src/AutoMerge/util.jl
index d41366be..9634333f 100644
--- a/src/AutoMerge/util.jl
+++ b/src/AutoMerge/util.jl
@@ -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"])