Skip to content

DOC: add new page 'how to read these doc' in get started section #39207

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
Closed
wants to merge 3 commits into from
Closed

DOC: add new page 'how to read these doc' in get started section #39207

wants to merge 3 commits into from

Conversation

rhuille
Copy link

@rhuille rhuille commented Jan 16, 2021 •
edited
Loading

This page explains the code block are run in notebook

@rhuille
Copy link
Author

rhuille commented Jan 16, 2021

Here is a screenshot of the new page:

image

@rhuille rhuille force-pushed the how-to-read-get-started-doc branch 2 times, most recently from 9bab609 to c631166 Compare January 16, 2021 21:21
afeld
afeld approved these changes Jan 21, 2021
View reviewed changes
Copy link
Member

@afeld afeld left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks good to me! I can imagine other things moving into this page (like the introductions to the sample data), but I think it's a good start. Approving, though I don't have merge rights.

@afeld afeld added the Docs label Jan 21, 2021
@afeld afeld mentioned this pull request Jan 21, 2021
Closed
@MarcoGorelli MarcoGorelli self-requested a review February 10, 2021 18:14
MarcoGorelli
MarcoGorelli suggested changes Feb 15, 2021
View reviewed changes
doc/source/getting_started/how_to_read_these_docs.rst Outdated



The first block is a standard python input, while in the second the ``In [1]:`` indicates the input is inside a `notebook <https://jupyter.org>`__. It does not make any difference **except the last line will be printed**.
Copy link
Member

Choose a reason for hiding this comment

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

Hi @rhuille - I'm not sure about this "except the last line will be printed" part. Is that really a defining feature of Jupyter Notebooks? Even in a Python repl, you would see the last line printed. Perhaps mention that, in Jupyter Notebooks, plots will be shown inline (e.g. see #39527 where someone was confused by how to work with the visualisation docs)

Copy link
Author

Choose a reason for hiding this comment

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

Hi @MarcoGorelli
Thanks for your feedback, I agree it's not defining Jupyter Notebooks, so let's rewrite it like this: 27c6bc6 what do you think ?

@jreback
Copy link
Contributor

jreback commented Feb 15, 2021

instead of a separate page how about a note at the top of the getting started docs.

@rhuille rhuille force-pushed the how-to-read-get-started-doc branch from 27c6bc6 to 686e133 Compare March 1, 2021 08:32
@MarcoGorelli MarcoGorelli self-requested a review March 10, 2021 11:03
MarcoGorelli
MarcoGorelli suggested changes Mar 10, 2021
View reviewed changes
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Hi @rhuille - could you address #39207 (comment) please?

@mroeschke
Copy link
Member

Thanks for the PR @rhuille but it appears this PR has gotten stale. Please let us know if you have time to merge master and to implement this as suggested in #39207 (comment) and we'd be happy to reopen. Closing for now.

@mroeschke mroeschke closed this Apr 11, 2021
@ehallam
Copy link
Contributor

ehallam commented Feb 22, 2022

Hi @mroeschke, I've picked up where @rhuille left off and I've added the changes to the top of the Getting Started page.
Does this look better? If so, I'll submit a new PR for my branch and reference it here.

PandasChanges

@mroeschke
Copy link
Member

Thanks @ehallam this looks pretty good. One suggestion: Instead of putting this in Getting Started, I think it's would be more appropriate in https://pandas.pydata.org/docs/user_guide/index.html since that's where most of the code snippets are.

@ehallam
Copy link
Contributor

ehallam commented Feb 22, 2022

Does this look good @mroeschke? I've also added a "Guides" heading to separate the "How to read these guides" section and the list of guides below.

PandasChanges4

@mroeschke
Copy link
Member

Looks great! Looking forward to the PR 👍

@ehallam ehallam mentioned this pull request Feb 22, 2022
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarcoGorelli MarcoGorelli MarcoGorelli requested changes

@afeld afeld afeld approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

DOC: "getting started" under "coming from SQL" assumes you're using a notebook
6 participants
@rhuille @jreback @mroeschke @ehallam @afeld @MarcoGorelli