Skip to content

Commit 263a5d9

Browse files
committed
Remove the tilde from the Repository documentation
Using the tilde in the documentation for repository initialization suggests that we perform tilde expansion in the path provided. We do no such thing, so remove it as it's quite unlikely someone does want a directory called '~' to have their git repos.
1 parent 6010046 commit 263a5d9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

ext/rugged/rugged_repo.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ static VALUE rb_git_repo_open_bare(int argc, VALUE *argv, VALUE klass)
336336
*
337337
* Examples:
338338
*
339-
* Rugged::Repository.new('~/test/.git') #=> #<Rugged::Repository:0x108849488>
339+
* Rugged::Repository.new('test/.git') #=> #<Rugged::Repository:0x108849488>
340340
* Rugged::Repository.new(path, :alternates => ['./other/repo/.git/objects'])
341341
*/
342342
static VALUE rb_git_repo_new(int argc, VALUE *argv, VALUE klass)
@@ -379,7 +379,7 @@ static VALUE rb_git_repo_new(int argc, VALUE *argv, VALUE klass)
379379
* A Rugged::Backend instance
380380
*
381381
*
382-
* Rugged::Repository.init_at('~/repository', :bare) #=> #<Rugged::Repository:0x108849488>
382+
* Rugged::Repository.init_at('repository', :bare) #=> #<Rugged::Repository:0x108849488>
383383
*/
384384
static VALUE rb_git_repo_init_at(int argc, VALUE *argv, VALUE klass)
385385
{

0 commit comments

Comments
 (0)