Skip to content
This repository was archived by the owner on Mar 26, 2021. It is now read-only.

Commit ecf284a

Browse files
authored
Add a docstring (#56)
1 parent 8a36044 commit ecf284a

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/git.jl

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
"""
2+
git()
3+
4+
Return a `Cmd` for running Git.
5+
6+
## Example
7+
8+
```julia
9+
julia> run(`$(git())` clone https://github.com/JuliaVersionControl/GitCommand.jl)
10+
```
11+
"""
112
function git(; adjust_PATH::Bool = true, adjust_LIBPATH::Bool = true)
213
@static if Sys.iswindows()
314
return Git_jll.git(; adjust_PATH, adjust_LIBPATH)::Cmd

0 commit comments

Comments
 (0)