Improve Documentation: Quick Start Guide, Key Functions, and Troubleshooting Section #621
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adnanhemani
requested changes
May 24, 2025
Member
adnanhemani
left a comment
adnanhemani
left a comment
There was a problem hiding this comment.
Not sure if this PR adds much value. I'd remove all changes and just provide a link to the Getting Started page that was linked in one of the comments. I'd just remove all changes and just add a link to the page that I linked from one of the comments under the "Quic Start Guide" header.
| ``` | ||
|
|
||
| ## Quick Start Guide |
Member
There was a problem hiding this comment.
I think this idea of putting a Getting Started experience on the README - but I think we're better off linking to this page, which is much more visual and comprehensive: https://www.data8.org/datascience/tutorial.html#getting-started
| - Table.hist(column) : Generates a histogram. | ||
| - Table.scatter(column_x, column_y) : Creates a scatter plot. | ||
|
|
||
| ## Troubleshooting Guide |
Member
There was a problem hiding this comment.
I don't think any of these are really useful. I'd recommend to just remove.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enhances the **README.**md documentation by adding:
These improvements aim to make it easier for new users to understand and use the datascience library effectively.