stan-dev / stan-dev/posterior

function argument variables or variable?

Open
#429 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
R
Stars
171
Forks
26
Avg merge
2d 18h
Merged PRs (30d)
3

Description

  • extract_list_of_variable_arrays() has argument named variables
  • set_variables() has argument named variables
  • subset_draws() has argument named variable

All these accept one or many variable names. Should these be unified to all use variable?

Currently if the argument is variables, using variable works, too, due to how R works. Would be enough to change the documentation for these?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the definitions and documentation for extract_list_of_variable_arrays(), set_variables(), and subset_draws(). Compare their argument naming and documented usage, then determine whether consistency requires documentation-only changes or implementation changes; done means the three interfaces present one clear convention.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
backend-api-design
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.