Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Avoid \linkS4class{} in documentation #508

Merged
merged 3 commits into from
Dec 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Suggests:
arrow,
blob,
covr,
DBItest,
DBItest (>= 1.8.2),
dbplyr,
downlit,
dplyr,
Expand Down
2 changes: 1 addition & 1 deletion R/dbClearResult.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#' @inheritSection DBItest::spec_result_clear_result Failure modes
#' @inheritSection DBItest::spec_result_clear_result Specification
#'
#' @param res An object inheriting from [DBIResult-class].
#' @param res An object inheriting from [DBI::DBIResult][DBIResult-class].
#' @param ... Other arguments passed on to methods.
#' @family DBIResult generics
#' @family DBIResultArrow generics
Expand Down
6 changes: 3 additions & 3 deletions R/dbConnect.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
#' @inherit DBItest::spec_driver_connect return
#' @inheritSection DBItest::spec_driver_connect Specification
#'
#' @param drv an object that inherits from [DBIDriver-class],
#' or an existing [DBIConnection-class]
#' @param drv An object that inherits from [DBI::DBIDriver][DBIDriver-class],
#' or an existing [DBI::DBIConnection][DBIConnection-class]
#' object (in order to clone an existing connection).
#' @param ... authentication arguments needed by the DBMS instance; these
#' @param ... Authentication arguments needed by the DBMS instance; these
#' typically include `user`, `password`, `host`, `port`, `dbname`, etc.
#' For details see the appropriate `DBIDriver`.
#' @seealso [dbDisconnect()] to disconnect from a database.
Expand Down
4 changes: 2 additions & 2 deletions R/dbDataType.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
#' @inheritSection DBItest::spec_result_create_table_with_data_type Specification
#'
#' @inheritParams dbListConnections
#' @param dbObj A object inheriting from [DBIDriver-class]
#' or [DBIConnection-class]
#' @param dbObj A object inheriting from [DBI::DBIDriver][DBIDriver-class]
#' or [DBI::DBIConnection][DBIConnection-class]
#' @param obj An R object whose SQL type we want to determine.
#' @family DBIDriver generics
#' @family DBIConnection generics
Expand Down
4 changes: 2 additions & 2 deletions R/dbFetch.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
#' @inheritSection DBItest::spec_result_fetch Specification
#' @inheritSection DBItest::spec_result_roundtrip Specification
#'
#' @param res An object inheriting from [DBIResult-class], created by
#' [dbSendQuery()].
#' @param res An object inheriting from [DBI::DBIResult][DBIResult-class],
#' created by [dbSendQuery()].
#' @param n maximum number of records to retrieve per fetch. Use `n = -1`
#' or `n = Inf`
#' to retrieve all pending records. Some implementations may recognize other
Expand Down
4 changes: 2 additions & 2 deletions R/dbFetchArrow.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
#' @inheritSection DBItest::spec_arrow_fetch_arrow Failure modes
#' @inheritSection DBItest::spec_arrow_fetch_arrow Specification
#'
#' @param res An object inheriting from [DBIResultArrow-class], created by
#' [dbSendQueryArrow()].
#' @param res An object inheriting from [DBI::DBIResultArrow][DBIResultArrow-class],
#' created by [dbSendQueryArrow()].
#' @param ... Other arguments passed on to methods.
#' @seealso Close the result set with [dbClearResult()] as soon as you
#' finish retrieving the records you want.
Expand Down
4 changes: 2 additions & 2 deletions R/dbFetchArrowChunk.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
#' @inheritSection DBItest::spec_arrow_fetch_arrow_chunk Failure modes
#' @inheritSection DBItest::spec_arrow_fetch_arrow_chunk Specification
#'
#' @param res An object inheriting from [DBIResultArrow-class], created by
#' [dbSendQueryArrow()].
#' @param res An object inheriting from [DBI::DBIResultArrow][DBIResultArrow-class],
#' created by [dbSendQueryArrow()].
#' @param ... Other arguments passed on to methods.
#' @seealso Close the result set with [dbClearResult()] as soon as you
#' finish retrieving the records you want.
Expand Down
4 changes: 2 additions & 2 deletions R/dbGetQuery.R
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
#' Subclasses should override this method only if they provide some sort of
#' performance optimization.
#'
#' @param conn A [DBIConnection-class] object, as returned by
#' [dbConnect()].
#' @param conn A [DBI::DBIConnection][DBIConnection-class] object,
#' as returned by [dbConnect()].
#' @param statement a character string containing SQL.
#' @param ... Other parameters passed on to methods.
#' @family DBIConnection generics
Expand Down
4 changes: 2 additions & 2 deletions R/dbGetQueryArrow.R
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@
#' Subclasses should override this method only if they provide some sort of
#' performance optimization.
#'
#' @param conn A [DBIConnection-class] object, as returned by
#' [dbConnect()].
#' @param conn A [DBI::DBIConnection][DBIConnection-class] object,
#' as returned by [dbConnect()].
#' @param statement a character string containing SQL.
#' @param ... Other parameters passed on to methods.
#' @family DBIConnection generics
Expand Down
4 changes: 2 additions & 2 deletions man/dbAppendTable.Rd

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

4 changes: 2 additions & 2 deletions man/dbAppendTableArrow.Rd

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

2 changes: 1 addition & 1 deletion man/dbBind.Rd

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

4 changes: 2 additions & 2 deletions man/dbCallProc.Rd

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

6 changes: 3 additions & 3 deletions man/dbCanConnect.Rd

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

2 changes: 1 addition & 1 deletion man/dbClearResult.Rd

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

2 changes: 1 addition & 1 deletion man/dbColumnInfo.Rd

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

6 changes: 3 additions & 3 deletions man/dbConnect.Rd

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

4 changes: 2 additions & 2 deletions man/dbCreateTable.Rd

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

4 changes: 2 additions & 2 deletions man/dbCreateTableArrow.Rd

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

4 changes: 2 additions & 2 deletions man/dbDataType.Rd

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

4 changes: 2 additions & 2 deletions man/dbDisconnect.Rd

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

4 changes: 2 additions & 2 deletions man/dbExecute.Rd

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

4 changes: 2 additions & 2 deletions man/dbExistsTable.Rd

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

4 changes: 2 additions & 2 deletions man/dbFetch.Rd

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

4 changes: 2 additions & 2 deletions man/dbFetchArrow.Rd

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

4 changes: 2 additions & 2 deletions man/dbFetchArrowChunk.Rd

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

4 changes: 2 additions & 2 deletions man/dbGetException.Rd

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

4 changes: 2 additions & 2 deletions man/dbGetQuery.Rd

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

4 changes: 2 additions & 2 deletions man/dbGetQueryArrow.Rd

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

2 changes: 1 addition & 1 deletion man/dbGetRowCount.Rd

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

2 changes: 1 addition & 1 deletion man/dbGetRowsAffected.Rd

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

2 changes: 1 addition & 1 deletion man/dbGetStatement.Rd

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

2 changes: 1 addition & 1 deletion man/dbHasCompleted.Rd

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

4 changes: 2 additions & 2 deletions man/dbListFields.Rd

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

4 changes: 2 additions & 2 deletions man/dbListObjects.Rd

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

4 changes: 2 additions & 2 deletions man/dbListResults.Rd

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

4 changes: 2 additions & 2 deletions man/dbListTables.Rd

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

Loading
Loading