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

r: add page #1524

Merged
merged 4 commits into from
Oct 11, 2017
Merged

r: add page #1524

merged 4 commits into from
Oct 11, 2017

Conversation

YangVincent
Copy link


  • The page (if new), does not already exist in the repo.

  • The page (if new), has been added to the correct platform folder:
    common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.

  • The page has 8 or fewer examples.

  • The PR is appropriately titled:
    <command name>: add page for new pages, or <command name>: <description of changes> for pages being edited

  • The page follows the contributing guidelines

@tldr-bot
Copy link

tldr-bot commented Oct 6, 2017

The build for this PR has failed with the following error(s):

pages/common/r.md:3: TLDR004 Command descriptions should end in a period
pages/common/r.md:13: TLDR005 Example descriptions should end in a colon

Please fix the error(s) and push again.

@agnivade agnivade changed the title R: add page r: add page Oct 7, 2017
@agnivade agnivade added the new command Issues requesting creation of a new page. label Oct 7, 2017
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Looks ok! Just a minor point or two 😺

@@ -0,0 +1,15 @@
# R
Copy link
Member

Choose a reason for hiding this comment

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

It really is a single letter command that's uppercase? That's rather unusual.

Copy link
Author

Choose a reason for hiding this comment

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

Yup! Though I've seen many versions where it calls for the lower case, though that may just be aliased.

Copy link
Member

Choose a reason for hiding this comment

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

I would really hate to break convention here. All our pages have the heading as lowercase. Unless there is a different command with a lower case r, I would recommend changing this to lowercase.


> R language interpreter.

- Call a R interactive shell (REPL):
Copy link
Member

Choose a reason for hiding this comment

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

I'd prefer an instead of a in this instance, as R is a single character.

Copy link
Author

Choose a reason for hiding this comment

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

Fixed!

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Looks ok to me!

@@ -0,0 +1,15 @@
# R
Copy link
Member

Choose a reason for hiding this comment

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

I would really hate to break convention here. All our pages have the heading as lowercase. Unless there is a different command with a lower case r, I would recommend changing this to lowercase.


`R --version`

- Run file as input:
Copy link
Member

Choose a reason for hiding this comment

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

Change this to - "Execute a file" to keep it consistent with pages of other programming languages.


- Run file as input:

`R -f file.R`
Copy link
Member

Choose a reason for hiding this comment

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

Wrap file.R in tokens


> R language interpreter.

- Call an R interactive shell (REPL):
Copy link
Member

Choose a reason for hiding this comment

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

Call => Start

@agnivade agnivade merged commit e274d45 into tldr-pages:master Oct 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants