Document that pkg_registry_name is only used
for looking up the package UUID, and it is registries
which determines where we search for user packages.
When i used this package like user("PackageInGeneralRegistry") is was pleasantly surprised to see it return a list containing a package in a private registry, because i misunderstood what the pkg_registry_name="General" keyword was doing (thinking it was also doing the job of registries). I think partly because the users(::String) method didn't document registries. So this PR tries to improve the docs to distinguish the two.
Document that
pkg_registry_nameis only used for looking up the package UUID, and it isregistrieswhich determines where we search for user packages.When i used this package like
user("PackageInGeneralRegistry")is was pleasantly surprised to see it return a list containing a package in a private registry, because i misunderstood what thepkg_registry_name="General"keyword was doing (thinking it was also doing the job ofregistries). I think partly because theusers(::String)method didn't documentregistries. So this PR tries to improve the docs to distinguish the two.