Skip to content

Commit

Permalink
Explain abbreviations and add links (#1914)
Browse files Browse the repository at this point in the history
  • Loading branch information
salim-b authored Feb 13, 2024
1 parent 29c73be commit f060cce
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
12 changes: 7 additions & 5 deletions R/describe.R
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#' describe: a BDD testing language
#'
#' A simple BDD DSL for writing tests. The language is similar to RSpec for
#' Ruby or Mocha for JavaScript. BDD tests read like sentences and it should
#' thus be easier to understand what the specification of a function/component
#' is.
#' A simple [behavior-driven development
#' (BDD)](https://en.wikipedia.org/wiki/Behavior-driven_development)
#' [domain-specific language](https://en.wikipedia.org/wiki/Domain-specific_language)
#' for writing tests. The language is similar to [RSpec](https://rspec.info/)
#' for Ruby or [Mocha](https://mochajs.org/) for JavaScript. BDD tests read
#' like sentences and it should thus be easier to understand what the
#' specification of a function/component is.
#'
#' Tests using the `describe` syntax not only verify the tested code, but
#' also document its intended behaviour. Each `describe` block specifies a
Expand All @@ -12,7 +15,6 @@
#' functions as a test and is evaluated in its own environment. You
#' can also have nested `describe` blocks.
#'
#'
#' This test syntax helps to test the intended behaviour of your code. For
#' example: you want to write a new function for your package. Try to describe
#' the specification first using `describe`, before your write any code.
Expand Down
10 changes: 6 additions & 4 deletions man/describe.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f060cce

Please sign in to comment.