Fix broken links in README.md

pyblish · Sep 27, 2016 · 29112d2 · 29112d2
1 parent 8381767
commit 29112d2
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -271,9 +271,9 @@ Starter exposes a series of interrelated APIs to the end-user.
 
 | Name                          | Purpose
 |:------------------------------|:--------------
-| [Filesystem API](#filesystem) | Defines how the **developer** interact with **data** on disk
-| [Starter API](#starter)       | Defines how the **developer** interacts with **Starter**
-| [Host API](#host)             | Defines how the **host** interacts with **Starter**
+| [Filesystem API](#filesystem-api) | Defines how the **developer** interact with **data** on disk
+| [Starter API](#starter-api)       | Defines how the **developer** interacts with **Starter**
+| [Host API](#host-api)             | Defines how the **host** interacts with **Starter**
 
 <br>
 <br>

diff --git a/docs/index.md b/docs/index.md
@@ -275,9 +275,9 @@ Starter exposes a series of interrelated APIs to the end-user.
 
 | Name                          | Purpose
 |:------------------------------|:--------------
-| [Filesystem API](#filesystem) | Defines how the **developer** interact with **data** on disk
-| [Starter API](#starter)       | Defines how the **developer** interacts with **Starter**
-| [Host API](#host)             | Defines how the **host** interacts with **Starter**
+| [Filesystem API](#filesystem-api) | Defines how the **developer** interact with **data** on disk
+| [Starter API](#starter-api)       | Defines how the **developer** interacts with **Starter**
+| [Host API](#host-api)             | Defines how the **host** interacts with **Starter**
 
 <br>
 <br>
@@ -497,18 +497,18 @@ Public members of `pyblish_starter.api`
 
 | Member                           | Returns  | Description
 |:---------------------------------|:---------|:--------
-| `ls()`                           | `dict`   | List available assets, relative `root`
-| `root()`                         | `str`    | Absolute path to current working directory
-| `format_staging_dir(root, name)` | `str`    | Return absolute path or staging directory relative arguments
-| `format_shared_dir(root)`        | `str`    | Return absolute path of shared directory
-| `format_version(version)`        | `str`    | Return file-system compatible string of `version`
-| `find_latest_version(versions)`  | `int`    | Given a series of string-formatted versions, return the latest one
-| `parse_version(version)`         | `str`    | Given an arbitrarily formatted string, return version number
-| `register_root(root)`            |          | Register currently active root
-| `register_host(host)`            |          | Register currently active host
-| `register_plugins()`             |          | Register plug-ins bundled with Pyblish Starter
-| `deregister_plugins()`           |          |
-| `registered_host()`              | `module` | Return currently registered host
+| `ls()`                           | `generator` | List available assets, relative `root`
+| `root()`                         | `str`       | Absolute path to current working directory
+| `format_staging_dir(root, name)` | `str`       | Return absolute path or staging directory relative arguments
+| `format_shared_dir(root)`        | `str`       | Return absolute path of shared directory
+| `format_version(version)`        | `str`       | Return file-system compatible string of `version`
+| `find_latest_version(versions)`  | `int`       | Given a series of string-formatted versions, return the latest one
+| `parse_version(version)`         | `str`       | Given an arbitrarily formatted string, return version number
+| `register_root(root)`            |             | Register currently active root
+| `register_host(host)`            |             | Register currently active host
+| `register_plugins()`             |             | Register plug-ins bundled with Pyblish Starter
+| `deregister_plugins()`           |             |
+| `registered_host()`              | `module`    | Return currently registered host
 
 <br>
 <br>
@@ -517,10 +517,11 @@ Public members of `pyblish_starter.api`
 
 A host must implement the following members.
 
-| Member                    | Returns | Description
-|:--------------------------|:--------|:--------
-| `create(name, family)`    | `dict`  | Build fixture for outgoing data (see [instance]())
-| `load(asset, version=-1)` | `str`   | Import external data into [container]()
+| Member                    | Returns    | Description
+|:--------------------------|:-----------|:--------
+| `ls()`                    | `generator`| Build fixture for outgoing data (see [instance]())
+| `create(name, family)`    | `dict`     | Build fixture for outgoing data (see [instance]())
+| `load(asset, version=-1)` | `str`      | Import external data into [container]()
 
 <br>