Add a docstring (#56)

JuliaVersionControl · Mar 23, 2021 · ecf284a · ecf284a
1 parent 8a36044
commit ecf284a
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/git.jl b/src/git.jl
@@ -1,3 +1,14 @@
+"""
+    git()
+
+Return a `Cmd` for running Git.
+
+## Example
+
+```julia
+julia> run(`$(git())` clone https://github.com/JuliaVersionControl/GitCommand.jl)
+```
+"""
 function git(; adjust_PATH::Bool = true, adjust_LIBPATH::Bool = true)
     @static if Sys.iswindows()
         return Git_jll.git(; adjust_PATH, adjust_LIBPATH)::Cmd