chore(docs): mention that autoc is decomissioned (closes #337)

gadicc · Nov 23, 2021 · 0a6df7a · 0a6df7a
1 parent 6b95d7e
commit 0a6df7a
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ const results = await yahooFInance.search('AAPL', { someOption: true, etc });
 ```
 
 Available modules:
-[`autoc`](./docs/modules/autoc.md),
+~[`autoc`](./docs/modules/autoc.md)~,
 [`historical`](./docs/modules/historical.md),
 [`quote`](./docs/modules/quote.md),
 [`quoteSummary`](./docs/modules/quoteSummary.md) (submodules:

diff --git a/docs/README.md b/docs/README.md
@@ -31,7 +31,7 @@ const result = await yahooFinance.module(query, queryOpts, moduleOpts);
 <a name="modules"></a>
 ## Modules
 
-1. [autoc](./modules/autoc.md) - autocomplete, great for symbol lookup.
+1. ~[autoc](./modules/autoc.md)~ - decomissioned, use [search](./modules/search.md) instead.
 1. [_chart](./modules/chart.md) - chart, like historical on steroids.
 1. [historical](./modules/historical.md) - historical market prices.
 1. [quote](./modules/quote.md) - essential symbol info.

diff --git a/docs/modules/autoc.md b/docs/modules/autoc.md
@@ -1,4 +1,9 @@
-# autoc (auto complete)
+# ~~autoc (auto complete)~~
+
+NB: Yahoo decomissioned their autoc server sometime before 20 Nov 2021
+(issue [#337](https://github.com/gadicc/node-yahoo-finance2/issues/337])).
+Use [search](./search.md) instead (just like they do).
+
 
 ## Usage:
 

diff --git a/docs/modules/quote.md b/docs/modules/quote.md
@@ -157,7 +157,7 @@ await yahooFinance.quote(symbol, queryOptions, moduleOptions);
 ### Symbol
 
 Symbol name as used by Yahoo (often the stock ticker).  You can find it
-using [autoc](./auto.md) or [search](./search.md).  You can also provide
+using [search](./search.md).  You can also provide
 an array of symbols, and you'll receive an array of results back.
 
 ### Query Options