Skip to content

37 update function argument table in ci upon release#38

Merged
ErikKusch merged 2 commits intomasterfrom
37-update-function-argument-table-in-ci-upon-release
Mar 31, 2026
Merged

37 update function argument table in ci upon release#38
ErikKusch merged 2 commits intomasterfrom
37-update-function-argument-table-in-ci-upon-release

Conversation

@thisistaimur
Copy link
Copy Markdown
Collaborator

Functionality added for automatically updating the .github/ArgumentUsage.xslx file on each merge to the master branch.

@thisistaimur thisistaimur requested a review from ErikKusch March 31, 2026 11:17
@thisistaimur thisistaimur added the documentation Improvements or additions to documentation label Mar 31, 2026
@thisistaimur thisistaimur linked an issue Mar 31, 2026 that may be closed by this pull request
@thisistaimur
Copy link
Copy Markdown
Collaborator Author

@ErikKusch ready when you are 📦

@ErikKusch
Copy link
Copy Markdown
Collaborator

ErikKusch commented Mar 31, 2026

Nice work, @thisistaimur! Afraid I got lost a bit on where function names are read out in the first place. From what I understand, function names are read from names of file names in the R directory. Some of the files therein contain multiple functions at present. An example: https://github.com/Clim-Hub/ClimHub/blob/master/R/Discovery_Functionality.r How does the document pipeline here handle these?

@thisistaimur
Copy link
Copy Markdown
Collaborator Author

thisistaimur commented Mar 31, 2026

@ErikKusch The functions names are being read from the files inside the R/ folder using the function parse_function_specs and then it looks for the corresponding .Rd file with the arguments. See:

parse_rd_arguments <- function(function_names, man_dir = "man") {

@ErikKusch ErikKusch merged commit b057b8b into master Mar 31, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update function argument table in CI upon release

2 participants