Update docs

pybotters · May 13, 2024 · 585f865 · 585f865
1 parent 5123ee6
commit 585f865
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -134,6 +134,8 @@ KuCoin
 Helpers
 -------
 
+.. _GMOCoinHelper:
+
 GMO Coin
 ~~~~~~~~
 

diff --git a/docs/exchanges.rst b/docs/exchanges.rst
@@ -66,6 +66,10 @@ Authentication
 
     また DataStore 側で「アクセストークンを延長」の定期リクエストが有効になる為、ユーザーコードでの延長処理は不要です。
 
+    :class:`.helpers.GMOCoinHelper` は「アクセストークンを延長」と「アクセストークンを取得」を自動で実行して、さらに Private WebSocket の URL を自動で更新する機能があります。
+    `GMO コインの定期メンテナンス <https://support.coin.z.com/hc/ja/articles/115007815487-%E3%82%B7%E3%82%B9%E3%83%86%E3%83%A0%E3%83%A1%E3%83%B3%E3%83%86%E3%83%8A%E3%83%B3%E3%82%B9%E6%99%82%E9%96%93%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6%E6%95%99%E3%81%88%E3%81%A6%E3%81%8F%E3%81%A0%E3%81%95%E3%81%84>`_ 後は通常、アクセストークンは失効しています。 このヘルパーを使ってアクセストークンを管理することによって、メンテナンス後の接続を確率するのに役に立ちます。
+    利用可能なコードは :ref:`Examples GMOCoinHelper <GMOCoinHelper>` をご覧ください。
+
 WebSocket
 ~~~~~~~~~