sonic-pi

https://github.com/sonic-pi-net/sonic-pi

C++

Code. Music. Live.

Rugged::TagCollection#create_annotation

Create a new annotated tag object with the specified +name+ on +target+ in
+repo+.

Unlike the +create+ method, +create_annotation+ simply creates a tag
object. It does not write a tag ref.

+annotation+ must have the following keys:

:tagger ::
  An optional Hash containing a git signature. Defaults to the signature
  from the configuration if only `:message` is given. Will cause the
  creation of an annotated tag object if present.

:message ::
  An optional string containing the message for the new tag.

Returns an instance of Rugged::Tag::Annotation representing the newly
created annotation.

Source | Google | Stack overflow

Edit

git clone [email protected]:sonic-pi-net/sonic-pi.git

cd sonic-pi

open app/server/ruby/vendor/rugged-1.7.1/ext/rugged/rugged_tag_collection.c

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Rugged--TagCollection-create_annotation-for-pr


# Commit to git

git add app/server/ruby/vendor/rugged-1.7.1/ext/rugged/rugged_tag_collection.cgit commit -m "better docs for Rugged::TagCollection#create_annotation"


# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Rugged--TagCollection-create_annotation-for-pr

hub pull-request


# Celebrate!