docs: add describe() and it() to pkgdown reference index#2340
Closed
LeonidasZhak wants to merge 1 commit into
Closed
docs: add describe() and it() to pkgdown reference index#2340LeonidasZhak wants to merge 1 commit into
LeonidasZhak wants to merge 1 commit into
Conversation
Fixes #2337 The functions describe() and it() are exported and have a help page (describe.Rd), but were not listed in the package reference index on the pkgdown site or in R help(package = 'testthat'). This adds them to the 'Basics' section of _pkgdown.yml alongside test_that(), as they are alternative BDD-style test-writing functions.
Author
|
Withdrawing this because checks are failing and this small documentation/index PR is not worth adding review burden in its current state. Sorry for the noise, and thank you for maintaining the project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2337
The functions describe and it are exported and have a help page (describe.Rd), but are not listed on the package reference index. This adds them to the Basics section of _pkgdown.yml alongside test_that.
Changes:
Validation: