Skip to content

Improve documentation for board_connect() #205

@juliasilge

Description

@juliasilge

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

Examples
--------
Use a server URL or set the `CONNECT_SERVER` environt variable to connect:
```python
server_url = "https://connect.rstudioservices.com"
board = board_connect(server_url)
```
In order to read a public pin, use `board_url()` with the public pin URL:
```python
# for a pin at https://connect.rstudioservices.com/content/3004/
board = board_url(
"https://connect.rstudioservices.com/content",
{"my_df": "3004/"}
)
board.pin_read("my_df")
```

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    .documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions