Skip to content

DOC: Edited/proofread the website's getting started page for readability #58853

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.

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

Closed
wants to merge 2 commits into from

Conversation

shindelr
Copy link
Contributor

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

I noticed that the Getting Started page had some typos and issues with sentence structure. I went through and modified index.rst to reflect what I hope are some quality changes in readability.

Also, I'm pretty new to GitHub and I had some trouble with the commit process. Somehow I included 12 images in my commit without modifying them, so I apologize in advance for the clutter.

Thanks for checking out my ideas!

Copy link

@chaityacshah chaityacshah left a comment

Choose a reason for hiding this comment

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

What are all these new images for?

@shindelr
Copy link
Contributor Author

I don't believe they're new, I think they're already part of the project. I had accidentally staged them and was unable to remove them from my commit. I didn't make any modifications to any images, or add/remove any images. The only thing I meant to be in this pr were my proposed changes to index.rst. Sorry about that!

@chaityacshah
Copy link

chaityacshah commented May 30, 2024 via email

@shindelr
Copy link
Contributor Author

shindelr commented May 30, 2024

Great, should I go ahead an close this pr? Then re-commit rebased with a clean commit history, then open a new pr?

@chaityacshah
Copy link

chaityacshah commented May 31, 2024 via email

@mroeschke
Copy link
Member

Great, should I go ahead an close this pr? Then re-commit rebased with a clean commit history, then open a new pr?

You can just run

git checkout upstream/main doc/
git commit -m"Undo doc changes"
git push origin HEAD

And update this PR

@shindelr
Copy link
Contributor Author

shindelr commented Jun 1, 2024

Okay, I followed the steps from @mroeschke and updated the PR with a rebase, so the second commit has the changes to index.rst but does not have the random images. Is this correct?

@mroeschke
Copy link
Member

It looks like your latest push still shows a diff for the images. I guess I would recommend creating a new pull request with just the changes to doc/source/getting_started/index.rst.

(Also as a best practice, I would recommend creating a branch from your main branch and create a pull request from that branch)

@shindelr
Copy link
Contributor Author

shindelr commented Jun 4, 2024

Okay, I went ahead and reset my main, checked out a new branch, and made the changes again with what I'm hoping is a clean pull request: #58919

Thanks for your patience and assistance! Feel free to close this PR, or let me know it's okay to close it.

@shindelr shindelr closed this Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants