Skip to content

Several roxygen comment lines use # instead of #', dropping them from rendered docs #186

Description

@EmilHvitfeldt

Issue

Four lines in roxygen comment blocks use # instead of #', which means they are treated as regular R comments and silently dropped from the rendered documentation.

Affected lines

R/smote_impl.R — line 23, inside the @details block of smote():

#' All columns in the data are sampled and returned by [recipes::juice()]
#  All columns used in this function must be numeric with no missing data.
#'                            ^ missing apostrophe

R/smotenc_impl.R — line 23, same pattern inside smotenc():

#  Columns can be numeric and categorical with no missing data.

R/bsmote_impl.R — line 25, inside the @details block of bsmote():

#  Points will be generated around points labeled "danger".

R/bsmote.R — line 36, inside the @details block of step_bsmote():

#  Points will be generated around points labeled "danger".

Fix

Add the missing ' to each line so it becomes part of the roxygen block, then re-document.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions