Skip to content

Commit 3ea6741

Browse files
authored
Corrects docstring for the as_df keyword (#183)
The specific behavior of the `as_df` keyword stated in the docstring template for specific fields is contrary to the keyword's main description, the keyword meaning and to its actual behavior: `as_df=false` for plain arrays, `as_df=true` for dataframes.
1 parent e86b1ce commit 3ea6741

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/abstract_datasets.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,9 @@ const ARGUMENTS_SUPERVISED_TABLE = """
9999

100100
const FIELDS_SUPERVISED_TABLE = """
101101
- `metadata`: A dictionary containing additional information on the dataset.
102-
- `features`: The data features. An array if `as_df=true`, otherwise a dataframe.
103-
- `targets`: The targets for supervised learning. An array if `as_df=true`, otherwise a dataframe.
104-
- `dataframe`: A dataframe containing both `features` and `targets`. It is `nothing` if `as_df=false`.
102+
- `features`: The data features. An array if `as_df=false`, otherwise a dataframe.
103+
- `targets`: The targets for supervised learning. An array if `as_df=false`, otherwise a dataframe.
104+
- `dataframe`: A dataframe containing both `features` and `targets`. It is `nothing` if `as_df=false`, otherwise a dataframed.
105105
"""
106106

107107
const METHODS_SUPERVISED_TABLE = """

0 commit comments

Comments
 (0)