Skip to content

ci: make argument usage generation tolerate conflicting new arg docs #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thisistaimur merged 3 commits into from
Jun 3, 2026
Merged

ci: make argument usage generation tolerate conflicting new arg docs #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b459ee8
ci: make argument usage generation tolerate conflicting new arg docs
thisistaimur Jun 3, 2026
d161375
docs: refresh ArgumentUsage workbook
thisistaimur Jun 3, 2026
91e9309
docs: refresh ArgumentUsage workbook
thisistaimur Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .github/ArgumentUsage.xlsx
View file
Open in desktop
Binary file not shown.
31 changes: 27 additions & 4 deletions .github/scripts/update_argument_usage.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,27 @@ normalize_arg_key <- function(x) {
x
}

synthesise_conflict_description <- function(arg_key, candidates) {
type_terms <- unique(unlist(regmatches(
tolower(candidates),
gregexpr("\\b(character|logical|numeric|integer|list|vector|function|data frame|sf|spatraster|cfvariable)\\b", tolower(candidates), perl = TRUE)
)))
type_terms <- type_terms[nzchar(type_terms)]

if (length(type_terms)) {
return(paste(
sprintf("%s.", paste(tools::toTitleCase(type_terms), collapse = "/")),
"Shared argument reused across package functions;",
"see function-specific help for exact behaviour."
))
}

paste(
"Shared argument reused across package functions;",
"see function-specific help for exact behaviour."
)
}

xml_escape <- function(x) {
x <- gsub("&", "&amp;", x, fixed = TRUE)
x <- gsub("<", "&lt;", x, fixed = TRUE)
Expand Down Expand Up @@ -414,7 +435,8 @@ build_doc_index <- function(ordered_functions, rd_docs) {

resolve_argument_description <- function(arg_key, existing_argument_map, doc_index) {
# Existing workbook text wins to avoid churn. New arguments must either
# have a single documented description or an explicit override above.
# have a single documented description, an explicit override above, or
# fall back to a generic shared-argument description.
if (!is.null(existing_argument_map[[arg_key]])) {
existing_usage <- existing_argument_map[[arg_key]]$usage
if (nzchar(normalize_ws(existing_usage))) {
Expand All @@ -434,12 +456,12 @@ resolve_argument_description <- function(arg_key, existing_argument_map, doc_ind
}

if (length(candidates) > 1) {
stop(
warning(
"Conflicting descriptions found for new argument ", arg_key, ": ",
paste(candidates, collapse = " | "),
". Add a canonical entry to argument_description_overrides in ",
".github/scripts/update_argument_usage.R."
". Falling back to a generic shared-argument description."
)
return(synthesise_conflict_description(arg_key, candidates))
}

candidates[[1]]
Expand Down Expand Up @@ -678,3 +700,4 @@ write_text(shared_strings_path, new_shared_xml)
write_text(sheet_path, new_sheet_xml)
repack_xlsx(tempdir, xlsx_path)
message("Updated ", xlsx_path)

Loading