Merge pull request #38 from Art4/fix_docs

Art4 · web-flow · commit e2bdbcc91f1c · 2017-06-01T15:04:46.000+02:00
Fix tables in docs
diff --git a/docs/objects-attributes.md b/docs/objects-attributes.md
@@ -12,10 +12,10 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-* | `string` | `mixed` |
-! | type |   | already used in [Resource Item object](objects-resource-item.md) |
-! | id | | already used in [Resource Item object](objects-resource-item.md) |
-! | relationships | | reserved by spec for future use |
-! | links | | reserved by spec for future use |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| *   | `string` | `mixed` |  |
+| !   | type |   | already used in [Resource Item object](objects-resource-item.md) |
+| !   | id | | already used in [Resource Item object](objects-resource-item.md) |
+| !   | relationships | | reserved by spec for future use |
+| !   | links | | reserved by spec for future use |
diff --git a/docs/objects-document-link.md b/docs/objects-document-link.md
@@ -12,12 +12,12 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-? | self | `string` |
-? | related | - `string`<br />- [Link object](objects-link.md) |
-? | first | - `null`<br />- `string` |
-? | last | - `null`<br />- `string` |
-? | prev | - `null`<br />- `string` |
-? | next | - `null`<br />- `string` |
-* | `string` | - `string`<br />- [Link object](objects-link.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| ?   | self | `string` |
+| ?   | related | - `string`<br />- [Link object](objects-link.md) |
+| ?   | first | - `null`<br />- `string` |
+| ?   | last | - `null`<br />- `string` |
+| ?   | prev | - `null`<br />- `string` |
+| ?   | next | - `null`<br />- `string` |
+| *   | `string` | - `string`<br />- [Link object](objects-link.md) |
diff --git a/docs/objects-document.md b/docs/objects-document.md
@@ -11,14 +11,14 @@ Property of: _none_
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-# | data | - [Resource Null object](objects-resource-null.md)<br />- [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Item object](objects-resource-item.md)<br />- [Resource Collection object](objects-resource-collection.md) | not allowed, if 'errors' exists
-# | errors | [Error Collection object](objects-error-collection.md) | not allowed, if 'data' exists
-# | meta | [Meta object](objects-meta.md) |
-? | jsonapi | [Jsonapi object](objects-jsonapi.md) |
-? | links | [Document Link object](objects-document-link.md) |
-? | included | [Resource Collection object](objects-resource-collection.md) | not allowed, if 'data' doesn't exist
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| #   | data | - [Resource Null object](objects-resource-null.md)<br />- [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Item object](objects-resource-item.md)<br />- [Resource Collection object](objects-resource-collection.md) | not allowed, if 'errors' exists |
+| #   | errors | [Error Collection object](objects-error-collection.md) | not allowed, if 'data' exists |
+| #   | meta | [Meta object](objects-meta.md) | |
+| ?   | jsonapi | [Jsonapi object](objects-jsonapi.md) | |
+| ?   | links | [Document Link object](objects-document-link.md) | |
+| ?   | included | [Resource Collection object](objects-resource-collection.md) | not allowed, if 'data' doesn't exist |
 
 ## Usage
 
diff --git a/docs/objects-error-collection.md b/docs/objects-error-collection.md
@@ -12,6 +12,6 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-+ | `integer` | [Error object](objects-error.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| +   | `integer` | [Error object](objects-error.md) | |
diff --git a/docs/objects-error-link.md b/docs/objects-error-link.md
@@ -12,7 +12,7 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-1 | about | - `string`<br />- [Link object](objects-link.md) |
-* | `string` | - `string`<br />- [Link object](objects-link.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| 1   | about | - `string`<br />- [Link object](objects-link.md) | |
+| *   | `string` | - `string`<br />- [Link object](objects-link.md) | |
diff --git a/docs/objects-error-source.md b/docs/objects-error-source.md
@@ -12,7 +12,7 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-? | pointer | `string` |
-? | parameter | `string` |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| ?   | pointer | `string` | |
+| ?   | parameter | `string` | |
diff --git a/docs/objects-error.md b/docs/objects-error.md
@@ -12,13 +12,13 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-? | id | `string` |
-? | links | [Error Link object](objects-error-link.md) |
-? | status | `string` |
-? | code | `string` |
-? | title | `string` |
-? | detail | `string` |
-? | source | [Error Source object](objects-error-source.md) |
-? | meta | [Meta object](objects-meta.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| ?   | id | `string` | |
+| ?   | links | [Error Link object](objects-error-link.md) | |
+| ?   | status | `string` | |
+| ?   | code | `string` | |
+| ?   | title | `string` | |
+| ?   | detail | `string` | |
+| ?   | source | [Error Source object](objects-error-source.md) | |
+| ?   | meta | [Meta object](objects-meta.md) | |
diff --git a/docs/objects-jsonapi.md b/docs/objects-jsonapi.md
@@ -12,7 +12,7 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-? | version | `string` | Default: `"1.0"`
-? | meta | [Meta object](objects-meta.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| ?   | version | `string` | Default: `"1.0"` |
+| ?   | meta | [Meta object](objects-meta.md) | |
diff --git a/docs/objects-link.md b/docs/objects-link.md
@@ -15,7 +15,7 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-1 | href | `string` |
-? | meta | [Meta object](objects-meta.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| 1   | href | `string` | |
+| ?   | meta | [Meta object](objects-meta.md) | |
diff --git a/docs/objects-meta.md b/docs/objects-meta.md
@@ -17,6 +17,6 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-* | `string` | `mixed` |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| *   | `string` | `mixed` | |
diff --git a/docs/objects-relationship-collection.md b/docs/objects-relationship-collection.md
@@ -12,8 +12,8 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-* | `string` | [Relationship object](objects-relationship.md) | not allowed, if already used in parents [Attributes object](objects-attributes.md) property)
-! | type |   | already used in [Resource Item object](objects-resource-item.md)
-! | id |   | already used in [Resource Item object](objects-resource-item.md)
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| *   | `string` | [Relationship object](objects-relationship.md) | not allowed, if already used in parents [Attributes object](objects-attributes.md) property) |
+| !   | type |   | already used in [Resource Item object](objects-resource-item.md) |
+| !   | id |   | already used in [Resource Item object](objects-resource-item.md) |
diff --git a/docs/objects-relationship-link.md b/docs/objects-relationship-link.md
@@ -12,12 +12,12 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-# | self | `string` |
-# | related | - `string`<br />- [Link object](objects-link.md) |
-? | first | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
-? | last | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
-? | prev | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
-? | next | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
-* | `string` | - `string`<br />- [Link object](objects-link.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| #   | self | `string` | |
+| #   | related | - `string`<br />- [Link object](objects-link.md) | |
+| ?   | first | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
+| ?   | last | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
+| ?   | prev | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
+| ?   | next | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
+| *   | `string` | - `string`<br />- [Link object](objects-link.md) | |
diff --git a/docs/objects-relationship.md b/docs/objects-relationship.md
@@ -12,8 +12,8 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-# | links | [Relationship Link object](objects-relationship-link.md) |
-# | data | - [Resource Null object](objects-resource-null.md)<br />- [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Identifier Collection object](objects-resource-identifier-collection.md) |
-# | meta | [Meta object](objects-meta.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| #   | links | [Relationship Link object](objects-relationship-link.md) | |
+| #   | data | - [Resource Null object](objects-resource-null.md)<br />- [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Identifier Collection object](objects-resource-identifier-collection.md) | |
+| #   | meta | [Meta object](objects-meta.md) | |
diff --git a/docs/objects-resource-collection.md b/docs/objects-resource-collection.md
@@ -12,6 +12,6 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-* | `integer` | - [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Item object](objects-resource-item.md) | Contains only [Resource Identifier object](objects-resource-identifier.md), if the collection is a property of a [Relationship object](objects-relationship.md)
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| *   | `integer` | - [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Item object](objects-resource-item.md) | Contains only [Resource Identifier object](objects-resource-identifier.md), if the collection is a property of a [Relationship object](objects-relationship.md) |
diff --git a/docs/objects-resource-identifier-collection.md b/docs/objects-resource-identifier-collection.md
@@ -12,6 +12,6 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-* | `integer` | [Resource Identifier object](objects-resource-identifier.md)
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| *   | `integer` | [Resource Identifier object](objects-resource-identifier.md) | |
diff --git a/docs/objects-resource-identifier.md b/docs/objects-resource-identifier.md
@@ -14,8 +14,8 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-1 | type | `string` |
-1 | id | `string` |
-? | meta | [Meta object](objects-meta.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| 1   | type | `string` | |
+| 1   | id | `string` | |
+| ?   | meta | [Meta object](objects-meta.md) | |
diff --git a/docs/objects-resource-item-link.md b/docs/objects-resource-item-link.md
@@ -12,8 +12,8 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-? | self | `string` |
-? | related | - `string`<br />- [Link object](objects-link.md) |
-* | `string` | - `string`<br />- [Link object](objects-link.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| ?   | self | `string` | |
+| ?   | related | - `string`<br />- [Link object](objects-link.md) | |
+| *   | `string` | - `string`<br />- [Link object](objects-link.md) | |
diff --git a/docs/objects-resource-item.md b/docs/objects-resource-item.md
@@ -13,11 +13,11 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-1 | type | `string` |
-1 | id | `string` |
-? | meta | [Meta object](objects-meta.md) |
-? | attributes | [Attributes object](objects-attributes.md) |
-? | relationships | [Relationship Collection object](objects-relationship-collection.md) |
-? | links | [Resource Item Link object](objects-resource-item-link.md) |
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| 1   | type | `string` | |
+| 1   | id | `string` | |
+| ?   | meta | [Meta object](objects-meta.md) | |
+| ?   | attributes | [Attributes object](objects-attributes.md) | |
+| ?   | relationships | [Relationship Collection object](objects-relationship-collection.md) | |
+| ?   | links | [Resource Item Link object](objects-resource-item-link.md) | |
diff --git a/docs/objects-resource-null.md b/docs/objects-resource-null.md
@@ -13,6 +13,6 @@ Property of:
 
 _[Symbols definition](objects-introduction.md#symbols)_
 
-    | Key | Value | Note
---- | ---- | ----- | ----
-_This object has no properties._
+|     | Key | Value | Note |
+| --- | --- | ----- | ---- |
+| !   |     |       | _This object has no properties._ |
