JuliaML / MLDatasets.jl

Utility package for accessing common Machine Learning datasets in Julia
https://juliaml.github.io/MLDatasets.jl/stable
MIT License
228 stars 47 forks source link

Corrects docstring for the `as_df` keyword #183

Closed vitaminace33 closed 2 years ago

vitaminace33 commented 2 years ago

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.

codecov-commenter commented 2 years ago

Codecov Report

Merging #183 (07ed819) into master (e86b1ce) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #183   +/-   ##
=======================================
  Coverage   36.29%   36.29%           
=======================================
  Files          43       43           
  Lines        2240     2240           
=======================================
  Hits          813      813           
  Misses       1427     1427           
Impacted Files Coverage Δ
src/abstract_datasets.jl 21.87% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

CarloLucibello commented 2 years ago

thanks!

vitaminace33 commented 2 years ago

yrw :D