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

Revise documentation for date format changes #195

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jasonpott
Copy link

As requested the changes have been applied to this document. The arrangement of the document differs to that output by the Roxygen document (paramater location). Hopefully it still makes sense.

this is linked to PR #194

As requested the changes have been applied to this document.  The arrangement of the document differs to that output by the Roxygen document (paramater location).  Hopefully it still makes sense.
Copy link
Owner

@colearendt colearendt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is perfect, thanks! Just a few tweaks with spacing / wording I would suggest.

Worth noting that you can "add these as a batch" and bundle into a single commit, which is probably preferable

#' # options(
#' # xlsx.date.format = 'dd/MM/YYYY',
#' # xlsx.datetime.format = 'dd/MM/YYYY HH:mm:ss'
#' #)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#' #)
#' # )

@@ -18,6 +18,11 @@
#' They need to be specified in Java date format
#' \url{https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html}.
#'
#'Changes to the xlsx date/time formats need to be passed to the R session using the
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#'Changes to the xlsx date/time formats need to be passed to the R session using the
#' Changes to the xlsx date/time formats need to be passed to the R session using the

@@ -18,6 +18,11 @@
#' They need to be specified in Java date format
#' \url{https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html}.
#'
#'Changes to the xlsx date/time formats need to be passed to the R session using the
#'R session function \code{option()} not as an xlsx package parameter.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#'R session function \code{option()} not as an xlsx package parameter.
#' \code{options()} function, not as an xlsx package parameter.

#'Changes to the xlsx date/time formats need to be passed to the R session using the
#'R session function \code{option()} not as an xlsx package parameter.
#'
#'An example of this syntax is shown below as a comment.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#'An example of this syntax is shown below as a comment.
#' An example of this syntax is shown below as a comment.

@colearendt colearendt changed the title Revise documentation for date format cchanges Revise documentation for date format changes Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants