posit-dev / posit-dev/connectapi
fix: `Variant$add_subscribers()` is misleadingly named and documented
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 54
- Forks
- 27
- Avg merge
- 1d 3m
- Merged PRs (30d)
- 1
Description
The private variants API supports adding subscribers one at a time. However, the variant method to call this endpoint is named add_subscribers and is documented in a way that suggests it supports passing in multiple GUIDs at once. (ref).
This method should be named add_subscriber. It should be accurately documented in a way that emphasizes that it only takes one GUID.
Source: Customer escalation (internal Slack link)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the VariantR6 reference page and search the package source for Variant$add_subscribers. Rename the method to add_subscriber and update its documentation to state that it accepts one GUID; done means the reference reflects the singular name and usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- api, documentation
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100