Datascience: Methods that need more docs

[SamLau95]

Housekeeping for which methods still need docs (just in the order they appear in
the documentation, not by priority).

These methods have just a sentence or two in the docstring.

Creation

• [ ] from_rows
• [ ] from_records
• [ ] read_table
• [ ] from_df
• [ ] from_array

Accessing Values

• [x] num_rows
• [x] rows
• [x] column_labels
• [x] columns
• [x] column_index
• [x] first
• [x] last

Mutation

• [ ] set_format
• [x] move_to_start
• [x] move_to_end
• [x] append
• [x] remove

Transformation (I'd say these are the most used methods)

• [ ] copy
• [x] drop
• [x] where
• [ ] sort
• [x] group
• [x] groups
• [ ] stack
• [ ] join
• [x] stats
• [ ] move_column
• [ ] pivot_bin (needs examples)

Exporting/Displaying

• [ ] show
• [ ] as_text
• [ ] as_html
• [ ] index_by
• [ ] to_df
• [ ] to_array

Visualizations

• [ ] plot
• [ ] points

Others

• [ ] Row class
• [ ] Rows class

---

These methods have better docs (eg. an example or a description of the args) but
I'd still say they could use more documentation.

• [ ] from_columns_dict
• [ ] pivot
• [ ] pivot_bin

[Brainz456]

Any of these still require updating?
I would be interesting in writing some up.

[adnanhemani]

@Brainz456 - yes these do. Please check the latest documentation at data8.org/datascience for the latest state/version of the documentation. If you do decide to work on this, please update the checklist above as well as you create PR(s) for these methods. Thanks!!

[erichamers]

Hey guys! Is anyone still working on this issue? I don't see any assignees, I'd be willing to jump in and help with this.

[adityakuppa26]

@SamLau95 @adnanhemani Isn't column_labels deprecated? Do we still add docstrings for such?

[adityakuppa26]

issue 163: added documentation for all accessing value methods #440

[adnanhemani]

@erichamers - we don't have any one person solely working on this issue. If you can, please fork our repo, and submit a PR! It'd be super appreciated!

@adityakuppa26 - I reviewed and merged #440. Thanks for this!! For column_labels, no need to make documentation for that - I'll mark it off on the list above.

[rajalakshmi139]

Hi
I would be interested in writing documents for some of the methods if they are still open.

[adnanhemani]

Hi @rajalakshmi139: yes, please check the methods above and send in a PR when you're ready. Thanks!

[davidwagner]

@rajalakshmi139, Agreed, would love to see PRs. Ideally, break up your work into a few separate PRs, rather than one giant PR with all of the documentation.

[hmstepanek]

Remaining documentation that needs to be done from the original issue:

Creation

• [ ] from_records
• [ ] read_table
• [ ] from_df
• [ ] from_array

Mutation

• [x] set_format
• [x] move_to_start
• [x] move_to_end
• [x] append
• [x] remove

Transformation (I'd say these are the most used methods)

• [ ] stack
• [ ] pivot_bin (needs examples)

Exporting/Displaying

• [ ] show
• [ ] as_text
• [ ] as_html
• [ ] index_by
• [ ] to_df
• [ ] to_array

Others

• [ ] Row class
• [ ] Rows class

[aryan26roy]

Hey, I am new to Open Source and i would like to contribute to this.

[adnanhemani]

Hi @aryan26roy, please see any of the methods above that still need documenting and send in a PR when you're ready. See an example PR for this (like #456 or #457) for a good example.

[SambhaviPD]

Does any of these require updating? I am new to open source and would like to contribute.

[adnanhemani]

Hi @SambhaviPD - please see above comment.

[SambhaviPD]

Hi @adnanhemani , are you referring to #390 or #165 (the list mentioned by @hmstepanek ?

[vrii14]

Hi, I'm new to open source and would like to contribute in these docs. Is any of these open?

[krisstee]

I have an included a PR to contribute to this issue. Please let me know if any adjustments need to be made!

[adnanhemani]

@SambhaviPD, @vrii14: The documentation that still needs to get done is in https://github.com/data-8/datascience/issues/163#issuecomment-691587722

[CodTan]

issue 163: Updated documentation for all methods of creating a table; PR #467

[CodTan]

Remaining documentation that needs to be done from the original issue (after PR #466 and #467):

Creation

• [x] from_records
• [x] read_table
• [x] from_df
• [x] from_array

Mutation

• [x] set_format
• [x] move_to_start
• [x] move_to_end
• [x] append
• [x] remove

Transformation (I'd say these are the most used methods)

• [x] stack
• [x] pivot_bin (needs examples)

Exporting/Displaying

• [ ] show
• [x] as_text
• [ ] as_html
• [ ] index_by
• [x] to_df
• [x] to_array

Others

• [ ] Row class
• [ ] Rows class

[vrii14]

@adnanhemani
Could you please guide me to where exactly is the row and rows classes? I couldn't find it.

[adnanhemani]

@vrii14 : Here