Skip to content

Commit d61c3d6

Browse files
committed
fix: pkg_doc_fun multiblock param docs
1 parent 1368eac commit d61c3d6

File tree

4 files changed

+33
-0
lines changed

4 files changed

+33
-0
lines changed

NEWS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
<!-- generated by R package codedoc; do not modify! -->
22

3+
## News for version 0.6.2
4+
5+
### codedoc::pkg_doc_fun
6+
7+
Fixed `codedoc::pkg_doc_fun` extraction of param docs.
8+
Multi-block docs could be mixed between parameters if they appeared in
9+
a mixed order in text. Now they do not.
10+
11+
312
## News for version 0.6.1
413

514
### codedoc::pkg_doc_fun

R/pkg_doc.R

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,12 @@ pkg_doc_codedoc_df__ <- function(
7272
}
7373
.__PKG_DOC_ENV__.[["text_file_df"]] <- new_text_file_df
7474
extract_arg_list <- as.list(extract_arg_list)
75+
# @codedoc_comment_block news("codedoc::pkg_doc_fun", "2025-03-19", "0.6.2")
76+
# Fixed `codedoc::pkg_doc_fun` extraction of param docs.
77+
# Multi-block docs could be mixed between parameters if they appeared in
78+
# a mixed order in text. Now they do not.
79+
# @codedoc_comment_block news("codedoc::pkg_doc_fun", "2025-03-19", "0.6.2")
80+
extract_arg_list[["sort_by"]] <- c("key", "first_block_line")
7581
extract_arg_list[["detect_allowed_keys"]] <- function(x) {
7682
pkg_nm <- read.dcf(
7783
"DESCRIPTION",

man/codedoc-package.Rd

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/pkg_doc.Rd

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)