Skip to content
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

Fix typos and code formatting in Docs #64

Merged
merged 1 commit into from
Oct 11, 2021
Merged

Fix typos and code formatting in Docs #64

merged 1 commit into from
Oct 11, 2021

Conversation

navidcy
Copy link
Contributor

@navidcy navidcy commented Oct 9, 2021

This PR fixes some typos + punctuation in the docs and enhances the code formatting in the inline examples provided in the docs.

@navidcy navidcy added the documentation Improvements or additions to documentation label Oct 9, 2021
@navidcy navidcy requested a review from odunbar October 9, 2021 05:31
@ilopezgp
Copy link
Contributor

Thanks! Can you please squash this PR into 1 commit when ready?

@ilopezgp ilopezgp self-requested a review October 11, 2021 00:27
@navidcy
Copy link
Contributor Author

navidcy commented Oct 11, 2021

Sure! How do I do that?

@ilopezgp
Copy link
Contributor

This is a useful guide to learn about squashing commits.

@navidcy
Copy link
Contributor Author

navidcy commented Oct 11, 2021

I failed miserably :(

@navidcy
Copy link
Contributor Author

navidcy commented Oct 11, 2021

Now I don't even know how to undo the mess I created. And most importantly, I'm afraid to try!

@ilopezgp
Copy link
Contributor

From your local branch, can you do the following?

git rebase -i HEAD~14

Then squash all your commits except the first one that appears in the list. Once the rebasing is done, do

git push --force

@navidcy
Copy link
Contributor Author

navidcy commented Oct 11, 2021

OK, I was missing the --force. Will do again!

changes $..$ to ..

better formatting

better code formatting

change $..$ -> .. and fix typos

$..$ --> .. + code inside

N_{it} -> N_{\rm it}

more punctuation and code formatting

more formatting

formatting, punctuation, and fix link

adds doi for Garbuno-Inigo et al 2020

simplify 10.0
@navidcy
Copy link
Contributor Author

navidcy commented Oct 11, 2021

Done. Thanks @ilopezgp!

Copy link
Contributor

@ilopezgp ilopezgp left a comment

Choose a reason for hiding this comment

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

LGTM

@navidcy
Copy link
Contributor Author

navidcy commented Oct 11, 2021

bors r+

@bors
Copy link
Contributor

bors bot commented Oct 11, 2021

Build succeeded:

@bors bors bot merged commit ab3f3cf into main Oct 11, 2021
@bors bors bot deleted the ncc/patch-docs branch October 11, 2021 01:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants