You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/10/19 09:01:38 UTC

[GitHub] [arrow] thisisnic commented on a diff in pull request #14455: MINOR: [R] [Docs] Fix link in ?cast documentation

thisisnic commented on code in PR #14455:
URL: https://github.com/apache/arrow/pull/14455#discussion_r999153848


##########
r/R/dplyr-funcs-type.R:
##########
@@ -43,7 +43,7 @@ register_bindings_type <- function() {
 #'   mutate(cyl = cast(cyl, string()))
 #' }
 #' @keywords internal
-#' @seealso https://arrow.apache.org/docs/cpp/api/compute.html for the list of
+#' @seealso [Arrow C++ documentation](https://arrow.apache.org/docs/cpp/compute.html) for the list of

Review Comment:
   Thanks for flagging this! So, the old link goes to the compute API docs, which isn't super helpful, and the new one suggested here goes to more user-friendly compute docs, which is much nicer, but I wonder if we need to do something else here.
   
   I'm thinking we may want to either:
   * be more specific and link to the cast options themselves, via https://arrow.apache.org/docs/cpp/api/compute.html#classarrow_1_1compute_1_1_cast_options or https://arrow.apache.org/docs/cpp/api/compute.html#_CPPv4N5arrow7compute11CastOptionsE (I'm not sure which of these links is more likely to be stable though)
   * manually describe the options here, and update them if new options are implemented - perhaps the API is stable enough now that this is unlikely
   
   What do you think?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org