Skip to content

Commit 7dc42f1

Browse files
Boolean values and indices.
1 parent f681309 commit 7dc42f1

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,14 @@ The source code is organized as follows:
115115

116116
## Low-level coventions
117117

118-
This project follows the [tidyverse style guide](http://style.tidyverse.org).
118+
This project follows the [tidyverse style guide](http://style.tidyverse.org).
119+
If we refer to specific variables / values etc. in the following sections, you
120+
can use RStudio's full text search to find where
121+
`remove_line_break_before_round_closing_after_curly()` is declared or called.
122+
119123

120124
### Files
125+
121126
* File names only contain alphanumeric characters and dashes.
122127
* Files are named according to topics / contexts, not according to functions
123128
that live in these files.
@@ -130,5 +135,14 @@ This project follows the [tidyverse style guide](http://style.tidyverse.org).
130135
* only very low-level functions or functions that don't fit in any other file
131136
go to `utils.R`.
132137

138+
### Boolean Values
133139

134-
140+
Functions that return Boolean values or variables that hold Boolean values are
141+
often prefixed with `is` or `has`. For example, `is_rmd_file(path)` is a
142+
function that returns `TRUE` if `path` is the path to a `.Rmd` file and `FALSE`
143+
otherwise.
144+
145+
### Vectors with indices
146+
147+
Vectors that hold indices are often suffixed with `idx`. `else_idx` for example
148+
indicates for every row in a parse table whether it contains an `else` token.

0 commit comments

Comments
 (0)