ropensci/qualtRics

Question/ comment about the documentation

Open

#341 opened on Apr 14, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)R (71 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (229 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hallo, I very much like your package!

I have a question. Not about a bug but a comment on the documentation.

I was wondering why all of the examples that are used in the documentation use the location: my_survey <- fetch_survey(surveyID = surveys$id[6]) instead of the string and the Unique ID. Like this: fetch_survey(surveyID = "SV_brr7rymdAnaGekS",

In the documentation, the use of the string and the Unique ID is explained:

surveyID String. Unique ID for the survey you want to download. Returned as id by the all_surveys function.

However, all of the examples use the surveys$id[6].

I would imagine that using the unique id (fetch_survey(surveyID = "SV_brr7rymdAnaGekS", ) would be preferred to the location, due to precision and due to consistency over time.

Or am I missing something?

Contributor guide

Research direction
Explain the reasoning behind using surveys$id[6] vs direct ID in documentation examples and consider updating examples to use direct IDs for clarity.
Tech stack
r
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
R
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90