1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/note.R
\name{note_remove}
\alias{note_remove}
\title{Remove the note for an object}
\usage{
note_remove(note = NULL, author = NULL, committer = NULL)
}
\arguments{
\item{note}{The note to remove}
\item{author}{Signature of the notes commit author.}
\item{committer}{Signature of the notes commit committer.}
}
\value{
invisible NULL
}
\description{
Remove the note for an object
}
\examples{
\dontrun{
## Create and initialize a repository in a temporary directory
path <- tempfile(pattern="git2r-")
dir.create(path)
repo <- init(path)
config(repo, user.name = "Alice", user.email = "alice@example.org")
## Create a file, add and commit
writeLines("Hello world!", file.path(path, "example.txt"))
add(repo, "example.txt")
commit_1 <- commit(repo, "Commit message 1")
## Create note in default namespace
note_1 <- note_create(commit_1, "Note-1")
## Create note in named (review) namespace
note_2 <- note_create(commit_1, "Note-2", ref="refs/notes/review")
## List notes in default namespace
notes(repo)
## List notes in 'review' namespace
notes(repo, "review")
## Remove notes
note_remove(note_1)
note_remove(note_2)
## List notes in default namespace
notes(repo)
## List notes in 'review' namespace
notes(repo, "review")
}
}
|