Skip to content

DOC: Get rid of question marks in getting started tutorials #48233

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
Merged
merged 4 commits into from
Aug 25, 2022
Merged

DOC: Get rid of question marks in getting started tutorials #48233

merged 4 commits into from
Aug 25, 2022

Conversation

samrao1997
Copy link
Contributor

@samrao1997 samrao1997 commented Aug 24, 2022 •
edited
Loading

mroeschke
mroeschke reviewed Aug 24, 2022
View reviewed changes
doc/source/getting_started/intro_tutorials/04_plotting.rst Outdated
@@ -2,7 +2,7 @@

{{ header }}

How do I create plots in pandas?
How to create plots in pandas
----------------------------------
Copy link
Member

Choose a reason for hiding this comment

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

All the - will need to match the length of these altered titles.

@mroeschke mroeschke added the Docs label Aug 24, 2022
@samrao1997 samrao1997 changed the title Get rid of question marks in getting started tutorials DOC: Get rid of question marks in getting started tutorials Aug 24, 2022
MarcoGorelli
MarcoGorelli suggested changes Aug 25, 2022
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.

The issue is about removing question marks when the heading isn't a question (e.g. "How to calculate summary statistics?"), heading that are already questions (e.g. "How do I create plots in pandas?") can stay as they are

@samrao1997
Copy link
Contributor Author

samrao1997 commented Aug 25, 2022 •
edited
Loading

@MarcoGorelli I adjusted PR so that it remains as is [aka How do I create plots? in the code].

However, I noticed that in the docs for some reason the plots heading shows How to with a question mark and when I added the previous change with How to without question mark building the docs got rid of the question mark on that page.

Not sure how the code show How do I when the docs show the heading How to....

MarcoGorelli
MarcoGorelli suggested changes Aug 25, 2022
View reviewed changes
doc/source/getting_started/intro_tutorials/06_calculate_statistics.rst Outdated
Comment on lines 33 to 34
How to calculate summary statistics
------------------------------------
Copy link
Member

Choose a reason for hiding this comment

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

you need to align the underscores (remove the last one)

@MarcoGorelli
Copy link
Member

Not sure how the code show How do I when the docs show the heading How to....

you probably just need to do python make.py clean first

@samrao1997
Copy link
Contributor Author

@MarcoGorelli I have updated the dashes to be the length of the alter titles. Sorry about that.

MarcoGorelli
MarcoGorelli approved these changes Aug 25, 2022
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.

Thanks @samrao1997

@MarcoGorelli MarcoGorelli added this to the 1.6 milestone Aug 25, 2022
@mroeschke mroeschke merged commit ed03e39 into pandas-dev:main Aug 25, 2022
@mroeschke
Copy link
Member

Thanks @samrao1997

@samrao1997 samrao1997 deleted the get-rid-of-questmark-tutorials branch August 26, 2022 00:39
@mroeschke mroeschke modified the milestones: 1.6, 2.0 Oct 13, 2022
noatamir pushed a commit to noatamir/pandas that referenced this pull request Nov 9, 2022
@samrao1997 @noatamir
DOC: Get rid of question marks in getting started tutorials (pandas-d…
dda069d 
…ev#48233)

* Get rid of question marks in getting started tutorials

* get rid of unneeded change

* Realign dashes with length of altered titles
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mroeschke mroeschke mroeschke approved these changes

@MarcoGorelli MarcoGorelli MarcoGorelli approved these changes

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

Successfully merging this pull request may close these issues.

DOC: wrong question marks in tutorial
3 participants
@samrao1997 @MarcoGorelli @mroeschke