Skip to content

Commit 14c5ae3

Browse files
authored
add a docstring to Registry module (#4432)
1 parent bbb9e6d commit 14c5ae3

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

src/Registry/Registry.jl

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
1+
"""
2+
Pkg.Registry
3+
4+
A module for managing Julia package registries.
5+
6+
Registries are repositories that contain metadata about available packages, including
7+
their versions, dependencies, and locations. The most common registry is the General
8+
registry, which hosts publicly available Julia packages.
9+
10+
# Main Functions
11+
12+
- [`Pkg.Registry.add`](@ref): Add new package registries
13+
- [`Pkg.Registry.rm`](@ref): Remove installed registries
14+
- [`Pkg.Registry.update`](@ref): Update installed registries
15+
- [`Pkg.Registry.status`](@ref): Display information about available registries
16+
17+
# Examples
18+
19+
```julia
20+
# Add the default registries (typically the General registry)
21+
Pkg.Registry.add()
22+
23+
# Add a specific registry by name, UUID, or URL
24+
Pkg.Registry.add("General")
25+
Pkg.Registry.add(url = "https://github.com/JuliaRegistries/General.git")
26+
27+
# Update all registries
28+
Pkg.Registry.update()
29+
30+
# Check registry status
31+
Pkg.Registry.status()
32+
33+
# Remove a registry
34+
Pkg.Registry.rm("General")
35+
```
36+
37+
See also: [`RegistrySpec`](@ref)
38+
"""
139
module Registry
240

341
import ..Pkg

0 commit comments

Comments
 (0)