Skip to content

DOC Adds note on dataframe in contributing guide#17359

Merged
adrinjalali merged 2 commits intoscikit-learn:masterfrom
thomasjpfan:docs_docstring_dataframe
Jun 25, 2020
Merged

DOC Adds note on dataframe in contributing guide#17359
adrinjalali merged 2 commits intoscikit-learn:masterfrom
thomasjpfan:docs_docstring_dataframe

Conversation

@thomasjpfan
Copy link
Copy Markdown
Member

As discussed during the monthly call, this PR adds documentation regarding using dataframe in a docstring.

CC @glemaitre

``{array-like, ndarray, sparse matrix, dataframe}``. Note that ``array-like``
can also be a ``list``, while ``ndarray`` is explicitly only a ``numpy.ndarray``.
5. When specifying the data type of a list, use ``of`` as a delimiter:
5. Specific ``dataframe`` when "frame-like" features are being used, such
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I might remove dataframe from l. 677 example because in most cases we will not have to specify it then.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

specific -> specify

@adrinjalali adrinjalali merged commit 9cf2bac into scikit-learn:master Jun 25, 2020
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Jul 17, 2020
* DOC Adds note on dataframe

* DOC Address comments
jayzed82 pushed a commit to jayzed82/scikit-learn that referenced this pull request Oct 22, 2020
* DOC Adds note on dataframe

* DOC Address comments
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.

4 participants