Skip to content

README Typo, Capitalization Changes #3645

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

Merged
merged 3 commits into from
Dec 2, 2019
Merged

README Typo, Capitalization Changes #3645

merged 3 commits into from
Dec 2, 2019

Conversation

carywreams
Copy link
Contributor

Found this while looking to contribute for another Documentation item.
Did not find an open issue for any of these items in the README file.

git log entry:

    Typo: "the the" to "the" in installation instructions
    Changes Capitalization of Book and Chapter names:
        Data Visualisation chapter ref (anchor only)
        Graphics for communication (anchor only, matches actual)
        R for Data Science book name (anchor and text usage)

Notes

Looked at a couple of other README.Rmd PRs.

Did not see changes to README.md in the PR, so making assumption that's somehow automated and out-of-scope for a README PR.

If needed here, will need instructions of generating an updated README.md from the .Rmd file.

    Typo: "the the" to "the" in installation instructions
    Changes Capitalization of Book and Chapter names:
        Data Visualisation chapter ref (anchor only)
        Graphics for communication (anchor only, matches actual)
        R for Data Science book name (anchor and text usage)
@clauswilke
Copy link
Member

To update README.md, please open README.Rmd in RStudio and click on the "knit" button. Then ament your PR so it contains both the updated README.Rmd and the updated README.md. Thanks!

@carywreams
Copy link
Contributor Author

Ah.
Don't suppose there's a command line option for this ?
If not, will take me a bit to get RStudio up and running to submit the PR for the README.

    side effect:
        modified:   man/figures/README-example-1.png
@carywreams
Copy link
Contributor Author

ok.

Managed to get that to work via RStudio, but there was a side effect: A png file was re-created (git diff says these files are different).

I suspect this was expected, so I left it in the commit.

@clauswilke
Copy link
Member

The new png is much smaller than the old one. @yutannihilation Any idea why by any chance? Did the default format change?

@clauswilke
Copy link
Member

One more request, while you're at it: Could you change the URLs to https where they exist (probably all of them)?

@yutannihilation
Copy link
Member

Not sure what causes the change (Pandoc 2 become smarter to resize the image to the necessary size?), but it seems reproducible. So, I think it's OK to merge.

Confession: I cheated on #3632 by editing README.md by hand, sorry... 🙄

@carywreams
Copy link
Contributor Author

okay - updated those specs to be https.

while testing the links, noticed many were converting to https at the site anyway (they were all updated in the README, regardless).

the png file did not re-gen upon this knitting.

Copy link
Member

@clauswilke clauswilke left a comment

Choose a reason for hiding this comment

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

Thanks!

@clauswilke clauswilke merged commit 913e936 into tidyverse:master Dec 2, 2019
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