-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
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
Conversation
There was a problem hiding this 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?
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 |
All good. You can git rebase to keep the commit history clean.
…On Wed, May 29, 2024 at 21:44 Robin Shindelman ***@***.***> wrote:
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!
—
Reply to this email directly, view it on GitHub
<#58853 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ADLDVCD7SZIPPGHIHZPOT5TZE2VBJAVCNFSM6AAAAABIN27NHOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZYGY3DQOJWGI>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
Great, should I go ahead an close this pr? Then re-commit rebased with a clean commit history, then open a new pr? |
Yes, please!
…On Thu, May 30, 2024 at 11:38 AM Robin Shindelman ***@***.***> wrote:
Great, should I go ahead an close this pr? Then re-commit rebased with a
clean commit history, then open a new pr?
—
Reply to this email directly, view it on GitHub
<#58853 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ADLDVCDT2V5N7BUD4ODXE6TZE5W2VAVCNFSM6AAAAABIN27NHOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNBQGYZDENZVGY>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
You can just run git checkout upstream/main doc/
git commit -m"Undo doc changes"
git push origin HEAD And update this PR |
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? |
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 (Also as a best practice, I would recommend creating a branch from your |
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. |
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!