From 67052891a8cc57c14373eac48d0471ccbf7c611d Mon Sep 17 00:00:00 2001 From: Justin Cook Date: Mon, 5 Aug 2024 12:36:48 -0500 Subject: [PATCH 1/3] readme: fix the spelling of async --- README.md | 2 +- docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ece52b6..ba9f549 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ The sfapi_client project relies on these libraries: * `pydantic` - Data models. * `tenacity` - Retry. * `datamodel-code-generator` - Generating data models from the Open API specification. -* `unasync` - Generating synchronous interface from asyn implementation. +* `unasync` - Generating synchronous interface from async implementation. ## Installation diff --git a/docs/index.md b/docs/index.md index 554c11b..b1825c7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -42,7 +42,7 @@ The sfapi_client project relies on these libraries: * `pydantic` - Data models. * `tenacity` - Retry. * `datamodel-code-generator` - Generating data models from the Open API specification. -* `unasync` - Generating synchronous interface from asyn implementation. +* `unasync` - Generating synchronous interface from async implementation. ## Installation From b8821e41ada8447e37c8b583ab9935882cfc482f Mon Sep 17 00:00:00 2001 From: Justin Cook Date: Mon, 5 Aug 2024 12:40:44 -0500 Subject: [PATCH 2/3] readme: fix the spelling of notebook --- README.md | 2 +- docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ba9f549..9decbdc 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Compute(name='perlmutter', full_name='Perlmutter', description='System Degraded' ## Documentation -For the basics, head over to the [QuickStart](https://nersc.github.io/sfapi_client/quickstart/). We also have Jupyter Nodebook [examples](https://nersc.github.io/sfapi_client/examples/). +For the basics, head over to the [QuickStart](https://nersc.github.io/sfapi_client/quickstart/). We also have Jupyter Notebook [examples](https://nersc.github.io/sfapi_client/examples/). More in depth developer documentation can be found in the [API reference](https://nersc.github.io/sfapi_client/reference/async/client/). diff --git a/docs/index.md b/docs/index.md index b1825c7..2f21552 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,7 +29,7 @@ Compute(name='perlmutter', full_name='Perlmutter', description='System Degraded' ## Documentation -For the basics, head over to the [QuickStart](quickstart). We also have Jupyter Nodebook [examples](examples). +For the basics, head over to the [QuickStart](quickstart). We also have Jupyter Notebook [examples](examples). More in depth developer documentation can be found in the [API reference](reference). From 30966ff07e3b24d57516cfe1c7672bf47a033992 Mon Sep 17 00:00:00 2001 From: Justin Cook Date: Mon, 5 Aug 2024 12:41:53 -0500 Subject: [PATCH 3/3] readme: fix the grammar of this line This allows it to be more consistant with the previous line. --- README.md | 2 +- docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9decbdc..e1c45b5 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ The sfapi_client project relies on these libraries: * `pydantic` - Data models. * `tenacity` - Retry. * `datamodel-code-generator` - Generating data models from the Open API specification. -* `unasync` - Generating synchronous interface from async implementation. +* `unasync` - Generating synchronous interface from the async implementation. ## Installation diff --git a/docs/index.md b/docs/index.md index 2f21552..5ec2b82 100644 --- a/docs/index.md +++ b/docs/index.md @@ -42,7 +42,7 @@ The sfapi_client project relies on these libraries: * `pydantic` - Data models. * `tenacity` - Retry. * `datamodel-code-generator` - Generating data models from the Open API specification. -* `unasync` - Generating synchronous interface from async implementation. +* `unasync` - Generating synchronous interface from the async implementation. ## Installation