Skip to content

Changing language from "Example" to "Examples" for docstrings #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
isabelizimm merged 2 commits into from
Jan 18, 2023
Merged

Changing language from "Example" to "Examples" for docstrings #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0ccf35
example -> examples for docstrings
isabelizimm Jan 18, 2023
df01ddd
example -> examples
isabelizimm Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions vetiver/monitor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def compute_metrics(
estimate:
Column name for predicted results

Example
Examples
-------
>>> from datetime import timedelta
>>> import pandas as pd
Expand Down Expand Up @@ -115,7 +115,7 @@ def pin_metrics(
If False, error when the new metrics contain overlapping dates with
the existing pin.

Example
Examples
-------
>>> import pins
>>> import vetiver
Expand Down Expand Up @@ -215,7 +215,7 @@ def plot_metrics(
n: str
Column in `df_metrics` containing number of observations

Example
Examples
-------
>>> import vetiver
>>> import pandas as pd
Expand Down
2 changes: 1 addition & 1 deletion vetiver/pin_read_write.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ def vetiver_pin_write(board, model: VetiverModel, versioned: bool = True):
versioned: bool
Whether or not the pin should be versioned

Example
Examples
-------
>>> import vetiver
>>> from pins import board_temp
Expand Down
2 changes: 1 addition & 1 deletion vetiver/rsconnect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def deploy_rsconnect(
image : str
Docker image to be specified for off-host execution

Example
Examples
-------
>>> import vetiver
>>> import pins
Expand Down
10 changes: 5 additions & 5 deletions vetiver/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class VetiverAPI:
**kwargs: dict
Deprecated parameters.

Example
Examples
-------
>>> import vetiver as vt
>>> X, y = vt.get_mock_data()
Expand Down Expand Up @@ -150,7 +150,7 @@ def vetiver_post(self, endpoint_fx: Callable, endpoint_name: str = None, **kw):
endpoint_name : str
Name of endpoint

Example
Examples
-------
>>> import vetiver as vt
>>> X, y = vt.get_mock_data()
Expand Down Expand Up @@ -199,7 +199,7 @@ def run(self, port: int = 8000, host: str = "127.0.0.1", **kw):
host : str
A valid IPv4 or IPv6 address, which the application will listen on.

Example
Examples
-------
>>> import vetiver as vt
>>> X, y = vt.get_mock_data()
Expand Down Expand Up @@ -244,7 +244,7 @@ def predict(endpoint, data: Union[dict, pd.DataFrame, pd.Series], **kw) -> pd.Da
dict
Endpoint_name and list of endpoint_fx output

Example
Examples
-------
>>> import vetiver
>>> X, y = vetiver.get_mock_data()
Expand Down Expand Up @@ -316,7 +316,7 @@ def vetiver_endpoint(url: str = "http://127.0.0.1:8000/predict") -> str:
url : str
URI path to endpoint

Example
Examples
-------
>>> import vetiver
>>> endpoint = vetiver.vetiver_endpoint(url='http://127.0.0.1:8000/predict')
Expand Down
2 changes: 1 addition & 1 deletion vetiver/vetiver_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class VetiverModel:



Example
Examples
-------
>>> from vetiver import mock, VetiverModel
>>> X, y = mock.get_mock_data()
Expand Down
2 changes: 1 addition & 1 deletion vetiver/write_docker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def write_docker(
port: str
Port to run VetiverAPI from Dockerfile

Example
Examples
-------
>>> import vetiver
>>> import tempfile
Expand Down
2 changes: 1 addition & 1 deletion vetiver/write_fastapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def write_app(
file :
Name of file

Example
Examples
-------
>>> import vetiver
>>> import tempfile
Expand Down