Skip to content

Commit

Permalink
Cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
mottosso committed Sep 27, 2016
1 parent 144bcb8 commit 841327a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,9 @@ A data FORMAT.

### Starter API

pyblish-starter provides a stateful API. State is set and modified by calling any of the exposed registration functions, prefixed `register_*`, or automatically when calling `pyblish_starter.install()`.
pyblish-starter provides a stateful API.

State is set and modified by calling any of the exposed registration functions, prefixed `register_*`, or automatically on calling `pyblish_starter.install()`.

<br>

Expand Down Expand Up @@ -505,6 +507,9 @@ Public members of `pyblish_starter.api`
| `register_plugins()` | | Register plug-ins bundled with Pyblish Starter
| `deregister_plugins()` | |
| `registered_host()` | `module` | Return currently registered host
| `registered_families()` | `list` | Return currently registered families
| `registered_data()` | `list` | Return currently registered data
| `registered_root()` | `str` | Return currently registered root

<br>
<br>
Expand All @@ -515,7 +520,7 @@ A host must implement the following members.

| Member | Returns | Description
|:--------------------------|:-----------|:--------
| `ls()` | `generator`| Build fixture for outgoing data (see [instance]())
| `ls()` | `generator`| List loaded assets
| `create(name, family)` | `dict` | Build fixture for outgoing data (see [instance]())
| `load(asset, version=-1)` | `str` | Import external data into [container]()

Expand Down
9 changes: 7 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,9 @@ A data FORMAT.

### Starter API

pyblish-starter provides a stateful API. State is set and modified by calling any of the exposed registration functions, prefixed `register_*`, or automatically when calling `pyblish_starter.install()`.
pyblish-starter provides a stateful API.

State is set and modified by calling any of the exposed registration functions, prefixed `register_*`, or automatically on calling `pyblish_starter.install()`.

<br>

Expand Down Expand Up @@ -509,6 +511,9 @@ Public members of `pyblish_starter.api`
| `register_plugins()` | | Register plug-ins bundled with Pyblish Starter
| `deregister_plugins()` | |
| `registered_host()` | `module` | Return currently registered host
| `registered_families()` | `list` | Return currently registered families
| `registered_data()` | `list` | Return currently registered data
| `registered_root()` | `str` | Return currently registered root

<br>
<br>
Expand All @@ -519,7 +524,7 @@ A host must implement the following members.

| Member | Returns | Description
|:--------------------------|:-----------|:--------
| `ls()` | `generator`| Build fixture for outgoing data (see [instance]())
| `ls()` | `generator`| List loaded assets
| `create(name, family)` | `dict` | Build fixture for outgoing data (see [instance]())
| `load(asset, version=-1)` | `str` | Import external data into [container]()

Expand Down

0 comments on commit 841327a

Please sign in to comment.