Skip to content

Conversation

olajoke
Copy link
Collaborator

@olajoke olajoke commented Apr 16, 2025

No description provided.

@olajoke olajoke requested a review from DivadNojnarg April 16, 2025 17:00
Copy link
Collaborator

@DivadNojnarg DivadNojnarg left a comment

Choose a reason for hiding this comment

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

@olajoke Thanks:

  • Can we add an example in the vignette to illustrate how this works?
  • Ensure we have minimum test coverage for this.

#' @param column_type Column type. By default, the column type is inferred from the data type of the column.
#' There are 7 possible options:
#' \itemize{
#' \item \code{"text"} for text columns.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We can use markdown syntax in roxygen2. It's easier than having \itemize ...
Instead it can be:

#' There are 7 possible options:
#' - Option 1
#' - Option 2

#' \item \code{"image"} for image columns.
#' \item \code{"radio"} for radio columns.
#' \item \code{"multilinetext"} for multiline text in columns.
#' \item \code{"multilinetext"} for multiline text columns.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Using markdown, \code{} becomes `code`

- `"menu"`: For dropdown menu selection columns

The `column_type` parameter is optional. If it is not specified, the column type will be inferred from the data type.
If `column_type` parameter is optional. If it is not specified, the column type will be inferred from the data type.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Typo?

@olajoke olajoke merged commit 6cc0804 into development Apr 29, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants