docs(kitsu-core): add examples for error

Author: wopian

packages/kitsu-core/src/error/index.js

@@ -3,6 +3,26 @@
  *
  * @param {Object} E The Error
  * @throws {Object} The mutated Error
+ *
+ * @example
+ * error('Hello')
+ *
+ * @example
+ * error({errors: [ { code: 400 } ]})
+ *
+ * @example
+ * error({
+ *   response: {
+ *     data: {
+ *       errors: [ {
+ *         title: 'Filter is not allowed',
+ *         detail: 'x is not allowed',
+ *         code: '102',
+ *         status: '400'
+ *       } ]
+ *     }
+ *   }
+ * })
  */
 export function error (E) {
   if (E.response) {