Skip to content

Commit f060cce

Browse files
authored
Explain abbreviations and add links (#1914)
1 parent 29c73be commit f060cce

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

R/describe.R

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
#' describe: a BDD testing language
22
#'
3-
#' A simple BDD DSL for writing tests. The language is similar to RSpec for
4-
#' Ruby or Mocha for JavaScript. BDD tests read like sentences and it should
5-
#' thus be easier to understand what the specification of a function/component
6-
#' is.
3+
#' A simple [behavior-driven development
4+
#' (BDD)](https://en.wikipedia.org/wiki/Behavior-driven_development)
5+
#' [domain-specific language](https://en.wikipedia.org/wiki/Domain-specific_language)
6+
#' for writing tests. The language is similar to [RSpec](https://rspec.info/)
7+
#' for Ruby or [Mocha](https://mochajs.org/) for JavaScript. BDD tests read
8+
#' like sentences and it should thus be easier to understand what the
9+
#' specification of a function/component is.
710
#'
811
#' Tests using the `describe` syntax not only verify the tested code, but
912
#' also document its intended behaviour. Each `describe` block specifies a
@@ -12,7 +15,6 @@
1215
#' functions as a test and is evaluated in its own environment. You
1316
#' can also have nested `describe` blocks.
1417
#'
15-
#'
1618
#' This test syntax helps to test the intended behaviour of your code. For
1719
#' example: you want to write a new function for your package. Try to describe
1820
#' the specification first using `describe`, before your write any code.

man/describe.Rd

+6-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)