search

rstudio / pins-python

https://rstudio.github.io/pins-python/
MIT License
46 stars 10 forks source link

Improve documentation for `board_connect()` #205

Closed juliasilge closed 9 months ago

juliasilge commented 11 months ago

Let's improve the docs for board_connect(), especially around how to use environment variables:

https://github.com/rstudio/pins-python/blob/ca9dde25cd23fb753b809c2119fd9757e18a52fa/pins/constructors.py#L434-L452

Internal users report they were not clear on how to actually set up their environment variables. Let's update this to be more like this vetiver demo where we show folks the code they really need to run.

Also note the typo to be fixed.

juliasilge commented 11 months ago

For R, we have the authentication details on the function reference page for board_connect() so I probably lean toward having it here, rather than as a section in a more general vignette.