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

Edit the vignettes to specify parameters by italicizing. #22

Open
daynefiler opened this issue Jun 15, 2018 · 2 comments
Open

Edit the vignettes to specify parameters by italicizing. #22

daynefiler opened this issue Jun 15, 2018 · 2 comments
Labels
enhancement New feature or request

Comments

@daynefiler
Copy link
Member

daynefiler commented Jun 15, 2018

Code blocks can be italicized by *`par = TRUE`*. It may be helpful to students to clarify when we are talking about a function vs parameter. Obviously, inline code like function(p1 = 1, p2 = 2) should be clear on its own.

We could then add a line to the "Using this document" section of each vignette about how we differentiate.

@daynefiler daynefiler added the enhancement New feature or request label Jun 15, 2018
@daynefiler
Copy link
Member Author

This is a lot of work. If we decide to do this, we should spread the work over a couple people and assign specific vignettes.

@daynefiler
Copy link
Member Author

As a note: RStudio allows you to highlight a segment of text, then press Shift+8 and it will add the stars around the highlighted text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant