Skip to content

Commit

Permalink
add stylerignore to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenzwalthert committed Dec 9, 2019
1 parent a3ec9a4 commit a3eaab9
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 14 deletions.
20 changes: 13 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,18 @@ There are a few variants of `style_text()`:
knitr::include_graphics("https://raw.githubusercontent.com/lorenzwalthert/some_raw_data/master/styler_0.1.gif")
```

## Functionality of styler
## Features

* style plain R, Rmd, .Rprofile and Rnw files.

* style roxygen2 code examples.

* not re-style deliberate code alignment
([vignette](https://styler.r-lib.org/articles/detect-alignment.html)).
* do not re-style [deliberate code
alignment](https://styler.r-lib.org/articles/detect-alignment.html).

* [ignore some lines](https://styler.r-lib.org/reference/stylerignore.html) for
styling (GitHub development version), also see `help("stylerignore")`.


**scope**

Expand Down Expand Up @@ -152,13 +156,13 @@ styler functionality is made available through other tools, most notably
name-of-the-chunk, tidy = "styler"}`), or `knitr::opts_chunk$set(tidy =
"styler")` at the top of your RMarkdown script.

* pretty-printing of [drake](https://github.com/ropensci/drake) workflow data
frames with `drake::drake_plan_source()`.

* Adding styler as a fixer to the [ale
Plug-in](https://github.com/w0rp/ale/pull/2401#issuecomment-485942966) for
VIM.

* pretty-printing of [drake](https://github.com/ropensci/drake) workflow data
frames with `drake::drake_plan_source()`.

* Adding styler with
[emacs-format-all-the-code](https://github.com/lassik/emacs-format-all-the-code)
for Emacs.
Expand All @@ -174,7 +178,9 @@ styler functionality is made available through other tools, most notably

* A [tidyverse.org blog
post](https://www.tidyverse.org/articles/2017/12/styler-1.0.0/) introducing
the functionality of styler.
the functionality of styler and a [follow-up
post](https://www.tidyverse.org/blog/2019/11/styler-1-2-0/) that introduces
the new features since release 1.0.0.

* The wiki of [Google Summer of Code
2017](https://github.com/rstats-gsoc/gsoc2017/wiki/Noninvasive-source-code-formatting)
Expand Down
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,19 @@ region.

<img src="https://raw.githubusercontent.com/lorenzwalthert/some_raw_data/master/styler_0.1.gif" width="650px" />

## Functionality of styler
## Features

- style plain R, Rmd, .Rprofile and Rnw files.

- style roxygen2 code examples.

- not re-style deliberate code alignment
([vignette](https://styler.r-lib.org/articles/detect-alignment.html)).
- do not re-style [deliberate code
alignment](https://styler.r-lib.org/articles/detect-alignment.html).

- [ignore some
lines](https://styler.r-lib.org/reference/stylerignore.html) for
styling (GitHub development version), also see
`help("stylerignore")`.

**scope**

Expand Down Expand Up @@ -148,13 +153,13 @@ styler functionality is made available through other tools, most notably
`knitr::opts_chunk$set(tidy = "styler")` at the top of your
RMarkdown script.

- pretty-printing of [drake](https://github.com/ropensci/drake)
workflow data frames with `drake::drake_plan_source()`.

- Adding styler as a fixer to the [ale
Plug-in](https://github.com/w0rp/ale/pull/2401#issuecomment-485942966)
for VIM.

- pretty-printing of [drake](https://github.com/ropensci/drake)
workflow data frames with `drake::drake_plan_source()`.

- Adding styler with
[emacs-format-all-the-code](https://github.com/lassik/emacs-format-all-the-code)
for Emacs.
Expand All @@ -171,7 +176,9 @@ styler functionality is made available through other tools, most notably

- A [tidyverse.org blog
post](https://www.tidyverse.org/articles/2017/12/styler-1.0.0/)
introducing the functionality of styler.
introducing the functionality of styler and a [follow-up
post](https://www.tidyverse.org/blog/2019/11/styler-1-2-0/) that
introduces the new features since release 1.0.0.

- The wiki of [Google Summer of Code
2017](https://github.com/rstats-gsoc/gsoc2017/wiki/Noninvasive-source-code-formatting)
Expand Down

0 comments on commit a3eaab9

Please sign in to comment.