Skip to content

docs: add cnd() to pkgdown reference index - #1904

Merged
lionel- merged 1 commit into
r-lib:mainfrom
LeonidasZhak:docs/add-cnd-to-pkgdown-reference
Jun 8, 2026
Merged

docs: add cnd() to pkgdown reference index#1904
lionel- merged 1 commit into
r-lib:mainfrom
LeonidasZhak:docs/add-cnd-to-pkgdown-reference

Conversation

@LeonidasZhak

Copy link
Copy Markdown
Contributor

Fixes #1900

Problem

The cnd(), error_cnd(), warning_cnd(), and message_cnd() constructors are documented in man/cnd.Rd and exported in NAMESPACE, but were missing from the pkgdown reference index at https://rlang.r-lib.org/reference/index.html.

Fix

Added cnd to the "Conditions" subsection in _pkgdown.yml.

Validation

  • YAML syntax validated with yaml::yaml.load_file()
  • The cnd entry resolves to man/cnd.Rd which documents all four constructors
  • cnd_muffle and cnd_type are intentionally omitted as they are marked \keyword{internal}

Diff

Single line addition in _pkgdown.yml:

- subtitle: Conditions
  contents:
+ - cnd
  - rlang_error
  - cnd_message
  - format_error_bullets
  - cnd_inherits

The cnd(), error_cnd(), warning_cnd(), and message_cnd() constructors
were documented but missing from the pkgdown reference index.

Fixes r-lib#1900
@lionel-
lionel- merged commit e9279f4 into r-lib:main Jun 8, 2026
13 checks passed
@lionel-

lionel- commented Jun 8, 2026

Copy link
Copy Markdown
Member

Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: cnd, message_cnd, warning_cnd, error_cnd missing from pkgdown reference

2 participants