Add documentation on how functions target a workspace, the `primary` one by default

arthur-shaw / susoapi

R interface for Survey Solutions' APIs

https://arthur-shaw.github.io/susoapi/

Other

9 stars 5 forks source link

Add documentation on how functions target a workspace, the `primary` one by default #22

Open arthur-shaw opened 2 years ago

arthur-shaw commented 2 years ago

Potential areas for change:

Getting started. Include a few examples that specify workspace and that target a workspace other than primary.
Authentication. User name and password can be set. Workspace needs to be specified.

ashwinikalantri commented 2 years ago

Do you think that the workspace attribute should default to primary? Does it make sense to force the user to specify the workspace, including primary. I have had slip-ups where I made changes to the primary workspace without intending to.

arthur-shaw commented 2 years ago

I like this idea. 👍

I'm revising the set_credentials() not to have a default value for the workspace argument. That way, there is less scope for accidentally providing credentials for the wrong workspace, and subsequently making changes in the wrong workspace.