Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Methods that need more docs #163

Closed
41 tasks done
SamLau95 opened this issue Dec 21, 2015 · 35 comments
Closed
41 tasks done

Methods that need more docs #163

SamLau95 opened this issue Dec 21, 2015 · 35 comments
Labels
documentation good first issue help wanted Spring2016
Milestone
SP17 Launch

Comments

@SamLau95
Copy link
Member

SamLau95 commented Dec 21, 2015 •
edited by adnanhemani

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 (adnanhemani edit: this method is now deprecated. No docs required.)
  • from_records
  • read_table
  • from_df
  • from_array

Accessing Values

  • num_rows
  • rows
  • column_labels
  • columns
  • column_index
  • first
  • last

Mutation

  • set_format
  • move_to_start
  • move_to_end
  • append
  • remove

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

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

Exporting/Displaying

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
@peterasujan peterasujan self-assigned this Feb 17, 2016
@papajohn papajohn modified the milestone: SP17 Launch Jan 12, 2017
@Brainz456
Copy link

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

@adnanhemani
Copy link
Member

@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!!

hongmei-codes added a commit to hongmei-codes/datascience that referenced this issue Jul 31, 2020
@hongmei-codes
tables.py: edited doc string
853f493 
added more details in the docstring
including example of how the docstring can be used

Completed one item in todo list of data-8#163
@hongmei-codes hongmei-codes mentioned this issue Jul 31, 2020
Merged
@erichamers
Copy link

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
Copy link
Contributor

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

@adityakuppa26
Copy link
Contributor

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

@adnanhemani
Copy link
Member

@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
Copy link

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

@adnanhemani
Copy link
Member

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

@adnanhemani adnanhemani mentioned this issue Aug 31, 2020
Closed
@davidwagner
Copy link
Member

@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.

This was referenced Sep 12, 2020
Merged
Merged
@hmstepanek
Copy link
Contributor

hmstepanek commented Sep 13, 2020 •
edited by adnanhemani

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

Creation

  • from_records
  • read_table
  • from_df
  • from_array

Mutation

  • set_format
  • move_to_start
  • move_to_end
  • append
  • 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

This was referenced Sep 13, 2020
Merged
Merged
@aryan26roy
Copy link

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

@adnanhemani
Copy link
Member

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.

@adnanhemani adnanhemani mentioned this issue Sep 18, 2020
Closed
@SambhaviPD
Copy link

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

@adnanhemani
Copy link
Member

Hi @SambhaviPD - please see above comment.

@SambhaviPD
Copy link

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

@vrii14
Copy link
Contributor

vrii14 commented Oct 1, 2020

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

@krisstee
Copy link
Contributor

krisstee commented Oct 2, 2020

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

@adnanhemani
Copy link
Member

@SambhaviPD, @vrii14: The documentation that still needs to get done is in #163 (comment)

@CodTan
Copy link
Contributor

CodTan commented Oct 2, 2020

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

@CodTan
Copy link
Contributor

CodTan commented Oct 2, 2020 •
edited by adnanhemani

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

Creation

  • from_records
  • read_table
  • from_df
  • from_array

Mutation

  • set_format
  • move_to_start
  • move_to_end
  • append
  • 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

adnanhemani added a commit that referenced this issue Oct 3, 2020
@adnanhemani
Merge pull request #466 from krisstee/master
1ad29a2 
Issue #163: Included documentation for to_array method.
SambhaviPD added a commit to SambhaviPD/datascience that referenced this issue Oct 4, 2020
@SambhaviPD
Issue data-8#163: Added documentation for method: stack
908f20c
SambhaviPD added a commit to SambhaviPD/datascience that referenced this issue Oct 7, 2020
@SambhaviPD
Issue data-8#163: Documentation added for method stack in transformation
7764e40
@SambhaviPD SambhaviPD mentioned this issue Oct 7, 2020
Closed
SambhaviPD added a commit to SambhaviPD/datascience that referenced this issue Oct 7, 2020
@SambhaviPD
Isue data-8#163: Fixed build errors in stack method
5ebcdbd
@vrii14
Copy link
Contributor

vrii14 commented Oct 9, 2020

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

@adnanhemani
Copy link
Member

@vrii14 : Here

@AdilGM
Copy link

AdilGM commented Jan 30, 2021

Hey! Is there any more documentation that needs to be done that I could help out with?

@adnanhemani
Copy link
Member

@AdilGM please check the list above - and if there's anything in the repo that's not listed here but doesn't have documentation, please feel free to send in a PR as well :)

@anshpujara14
Copy link

Hey anymore documentation required to be done? Willing to help!

@davidwagner
Copy link
Member

@anshpujara14 Thank you for your offer -- see the list at the top of this issue for some ideas on further documentation!

@bcwachtel
Copy link

First-timer here. Happy to help out. Any guidelines for contributing to docs I should know about (re: style, examples, formatting etc.)?

@davidwagner
Copy link
Member

@PubliusV, If you take a look at the style we've used for other docs and follow them, that should get you most of the way.

@HarshKumarSingh07
Copy link

Hey everyone, @davidwagner @adnanhemani, I have generated a pull request kindly verify once and please suggest improvements if required. I being a newbie to open source, any suggestions would be highly appreciated.

@Hetarth02
Copy link

I would like to help with documentation, can someone please guide me on the current stats of the docs and which topics need documentation?

@davidwagner davidwagner mentioned this issue Oct 6, 2021
Closed
@Shershon25
Copy link
Contributor

Hey! If no one is currently adding documentation to the 'Rows' class, can I try adding to it?

@adnanhemani
Copy link
Member

Hi @Shershon25 - we don’t have anyone working on this AFAIK. Please feel free to take any methods/classes and open a PR whenever your code is ready!

@Shershon25
Copy link
Contributor

Shershon25 commented Aug 13, 2022 •
edited

Thank you @adnanhemani ! I have opened a PR.

@adnanhemani
Copy link
Member

I believe we've now concluded all of the above listed methods. I will run another audit through all the files and list any methods that require more documentation. Once I complete that, I'll close this issue and open new ones.

@adnanhemani
Copy link
Member

This task is actually finished, I'm going to send in some updates for the misformatting of some methods. Thanks all for your help!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation good first issue help wanted Spring2016
Projects
None yet
Milestone
SP17 Launch
Development

No branches or pull requests