Add improved docs

Author: wooorm

example.js

@@ -0,0 +1,21 @@
+import {h, s} from './index.js'
+
+// Children as an array:
+console.log(
+  h('.foo#some-id', [
+    h('span', 'some text'),
+    h('input', {type: 'text', value: 'foo'}),
+    h('a.alpha', {class: 'bravo charlie', download: 'download'}, [
+      'delta',
+      'echo'
+    ])
+  ])
+)
+
+// SVG:
+console.log(
+  s('svg', {xmlns: 'http://www.w3.org/2000/svg', viewbox: '0 0 500 500'}, [
+    s('title', 'SVG `<circle>` element'),
+    s('circle', {cx: 120, cy: 120, r: 100})
+  ])
+)

html.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('./lib/index.js').Child} Child Acceptable child value
- * @typedef {import('./lib/index.js').Properties} Properties Acceptable properties value.
+ * @typedef {import('./lib/index.js').Child} Child
+ * @typedef {import('./lib/index.js').Properties} Properties
  */
 
 export {h} from './lib/html.js'

index.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('./lib/index.js').Child} Child Acceptable child value
- * @typedef {import('./lib/index.js').Properties} Properties Acceptable properties value.
+ * @typedef {import('./lib/index.js').Child} Child
+ * @typedef {import('./lib/index.js').Properties} Properties
  */
 
 export {h, s} from './lib/index.js'

lib/core.js

@@ -14,10 +14,12 @@
  * @typedef {Array<string|number>} HArrayValue
  * @typedef {HPrimitiveValue|HArrayValue} HPropertyValue
  * @typedef {{[property: string]: HPropertyValue|HStyle}} HProperties
+ *   Acceptable properties value.
  *
  * @typedef {string|number|null|undefined} HPrimitiveChild
  * @typedef {Array<Node|HPrimitiveChild>} HArrayChild
  * @typedef {Node|HPrimitiveChild|HArrayChild} HChild
+ *   Acceptable child value
  */
 
 import {find, normalize} from 'property-information'

lib/index.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('./core.js').HChild} Child Acceptable child value
- * @typedef {import('./core.js').HProperties} Properties Acceptable properties value.
+ * @typedef {import('./core.js').HChild} Child
+ * @typedef {import('./core.js').HProperties} Properties
  */
 
 export {h} from './html.js'

lib/runtime.js

@@ -8,7 +8,7 @@
  * @typedef {import('./core.js').HStyle} HStyle
  * @typedef {import('./core.js').core} Core
  *
- * @typedef {{[x: string]: HPropertyValue|HStyle|HChild}} JSXProps
+ * @typedef {Record<string, HPropertyValue|HStyle|HChild>} JSXProps
  */
 
 /**

lib/svg.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('./core.js').HChild} Child Acceptable child value
- * @typedef {import('./core.js').HProperties} Properties Acceptable properties value.
+ * @typedef {import('./core.js').HChild} Child
+ * @typedef {import('./core.js').HProperties} Properties
  *
  * @typedef {import('./jsx-classic').Element} s.JSX.Element
  * @typedef {import('./jsx-classic').IntrinsicAttributes} s.JSX.IntrinsicAttributes