Azure / AzureKeyVault

R interface to Azure Key Vault
Other
14 stars 7 forks source link

key_vault() docs misleading #10

Closed JosiahParry closed 2 years ago

JosiahParry commented 2 years ago

Rendered help documentation from CRAN AzureKeyVault v1.0.5 states:

An OAuth token obtained via get_azure_token or get_managed_token. If provided, this overrides the other authentication arguments.

https://github.com/Azure/AzureKeyVault/blob/c97b9bee977fca41c650bdf0016850b9f72c49a9/R/vault_endpoint.R#L84

Argument token references functions get_azure_token() and get_managed_token() neither of which are exported from AzureKeyVault. Please indicate their respective packages via namespace.

According to https://github.com/Azure/AzureKeyVault/blob/c97b9bee977fca41c650bdf0016850b9f72c49a9/R/vault_endpoint.R#L135 they should be accessed from AzureAuth. Please document these as from their namespace.

hongooi73 commented 2 years ago

See

https://github.com/Azure/AzureKeyVault/blob/c97b9bee977fca41c650bdf0016850b9f72c49a9/R/vault_endpoint.R#L81

and

https://github.com/Azure/AzureKeyVault/blob/c97b9bee977fca41c650bdf0016850b9f72c49a9/R/vault_endpoint.R#L110-L113

JosiahParry commented 2 years ago

Please reference the below reproducible example. The roxygen does not render as you would anticipate. The rendered documentation as installed from CRAN moments ago does not reference the package. Note that the issue is not with tenant, and app param, but token.

require("AzureKeyVault")
#> Loading required package: AzureKeyVault
#> Warning in library(package, lib.loc = lib.loc, character.only = TRUE,
#> logical.return = TRUE, : there is no package called 'AzureKeyVault'
install.packages("AzureKeyVault")
#> 
#> The downloaded binary packages are in
#>  /var/folders/wd/xq999jjj3bx2w8cpg7lkfxlm0000gn/T//RtmpEM0EMu/downloaded_packages
packageVersion("AzureKeyVault")
#> [1] '1.0.5'
?AzureKeyVault::key_vault
image
hongooi73 commented 2 years ago

As a matter of style, I only hyperlink the first instance of the term. You can afford to look 2 lines up.