Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kalimu committed Dec 6, 2024
1 parent b6f770f commit 13ec25d
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 2 deletions.
2 changes: 2 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Generated by roxygen2: do not edit by hand

export(add_files)
export(find_records)
export(initialize_project)
export(is_verbose)
export(process_repos)
export(set_database)
export(set_github_repos)
export(set_gitlab_repos)
export(set_llm)
Expand Down
9 changes: 7 additions & 2 deletions R/find_records.R
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
#' Finding top K records in a vector database.
#'

Check warning on line 2 in R/find_records.R

View workflow job for this annotation

GitHub Actions / lint

file=R/find_records.R,line=2,col=3,[trailing_whitespace_linter] Trailing whitespace is superfluous.
#' @param query A character, user query.
#' @param top_k A numeric, number of top K records to return.
#' @inheritParams process_repos
#'

Check warning on line 6 in R/find_records.R

View workflow job for this annotation

GitHub Actions / lint

file=R/find_records.R,line=6,col=3,[trailing_whitespace_linter] Trailing whitespace is superfluous.
#' @export
find_records <- function(
gitai,

Check warning on line 9 in R/find_records.R

View workflow job for this annotation

GitHub Actions / lint

file=R/find_records.R,line=9,col=9,[trailing_whitespace_linter] Trailing whitespace is superfluous.
Expand All @@ -10,5 +16,4 @@ find_records <- function(
query = query,

Check warning on line 16 in R/find_records.R

View workflow job for this annotation

GitHub Actions / lint

file=R/find_records.R,line=16,col=19,[trailing_whitespace_linter] Trailing whitespace is superfluous.
top_k = top_k
)

}
}
6 changes: 6 additions & 0 deletions R/set_database.R
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
#' Setting database in `GitAI` object.
#'
#' @inheritParams process_repos
#' @param provider A string. Name of database provider.
#' @param ... Additional arguments to pass to database provider constructor.
#'
#' @export
set_database <- function(
gitai,
Expand Down
21 changes: 21 additions & 0 deletions man/find_records.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions man/set_database.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 13ec25d

Please sign in to comment.