stan-dev / stan-dev/rstan

Remove "get_" prefixes from function names

Open
#276 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
1.1k
Forks
266
Avg merge
2h 56m
Merged PRs (30d)
1

Description

Suggestion from @bob-carpenter:

I'd recommend removing "get_" prefixes; "set_" is OK, but "get_" doesn't
really add any info, just four more characters.

I'm fine with deprecating the functions with get_ prefixes (get_sampler_params, get_inits, etc.). I don't think we would have any name conflicts with existing functions, so we should be able to just drop the get_ prefixes and keep the resulting function names. Eventually we can disallow the get_ versions entirely.

Contributor guide

No contributing guide indexed for this repository

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 by locating the public functions named get_sampler_params, get_inits, and other get_-prefixed entry points in the RStan source. Inventory their existing tests and callers, then verify that the unprefixed names work while the deprecated names remain covered until eventual removal.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.