From 3947e046e658d49a24b105e99854262259652de0 Mon Sep 17 00:00:00 2001 From: Brad Lindsay Date: Fri, 29 Mar 2024 08:01:55 -0500 Subject: [PATCH] Fix typos in documentation Some method calls were missing commas between multi-line arguments, and the table about response methods had `header` instead of `headers`. --- docs/usage/custom_apps.md | 6 +++--- docs/usage/rest.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/usage/custom_apps.md b/docs/usage/custom_apps.md index 3cb04d0c..b09a03be 100644 --- a/docs/usage/custom_apps.md +++ b/docs/usage/custom_apps.md @@ -10,7 +10,7 @@ You can follow instructions for [initializing the session object](#initializing- Following is a basic example to construct a simple Session object. You can see full list of parameters for this object in the [class definition](https://github.com/Shopify/shopify-api-ruby/blob/main/lib/shopify_api/auth/session.rb) ```ruby session = ShopifyAPI::Auth::Session.new( - shop: "#{your_shop_name}.myshopify.com" + shop: "#{your_shop_name}.myshopify.com", access_token: "the_token_for_your_custom_app_found_in_admin" ) @@ -23,7 +23,7 @@ Example: def make_api_request(shop) # 1. create session object session = ShopifyAPI::Auth::Session.new( - shop: "#{your_shop_name}.myshopify.com" + shop: "#{your_shop_name}.myshopify.com", access_token: "the_token_for_your_custom_app_found_in_admin" ) @@ -49,7 +49,7 @@ Example: def configure_app # This method is called before making authenticated API calls session = ShopifyAPI::Auth::Session.new( - shop: "#{your_shop_name}.myshopify.com" + shop: "#{your_shop_name}.myshopify.com", access_token: "the_token_for_your_custom_app_found_in_admin" ) diff --git a/docs/usage/rest.md b/docs/usage/rest.md index 6f6f7840..f1dd99ae 100644 --- a/docs/usage/rest.md +++ b/docs/usage/rest.md @@ -218,7 +218,7 @@ If the request is successful these methods will all return a [`ShopifyAPI::Clien | Methods | Type | Notes | |---------|------|-------| | `code` |`Integer`| HTTP Response code, e.g. `200`| -| `header` |`Hash{String, [String]}` | HTTP Response headers | +| `headers` |`Hash{String, [String]}` | HTTP Response headers | | `body` | `Hash{String, Untyped}` | HTTP Response body | | `prev_page_info` | `String` | See [Pagination](#pagination)| | `next_page_info` | `String` | See [Pagination](#pagination)|