Skip to content

Commit 22b5857

Browse files
committed
📃 docs(README): Adjust formatting
1 parent 4ee9edc commit 22b5857

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,13 @@ Here’s a comparison of the features of **showify**, `util.inspect` in Node.js,
117117
| WeakMap/WeakSet inspection | 🟡 [5] ||||
118118
| Proxy inspection |||||
119119

120-
<small>[1]: object-inspect only supports single or double quotes, while **showify** supports automatic quote style.</small>
121-
<small>[2]: In addition to `showHidden: boolean` from Node.js, **showify** also provides an `"exclude-meta"` option, which behaves like `true` but removes common meta properties like the `length` property of arrays from the output.</small>
122-
<small>[3]: Whether to treat getters/setters specially. Getters may throw errors, so it’s important to account for such cases.</small>
123-
<small>[4]: `Promise` objects are displayed as `Promise { <state unknown> }`, since it’s impossible to determine the state of a `Promise` without awaiting it.</small>
124-
<small>[5]: `WeakMap` and `WeakSet` objects are displayed as `${className} { <items unknown> }` even when `showHidden` is `"always"`, since it’s impossible to retrieve the values of a `WeakMap` or `WeakSet` without knowing the keys.</small>
120+
<p>
121+
<div><small>[1]: object-inspect only supports single or double quotes, while <strong>showify</strong> supports automatic quote style.</small></div>
122+
<div><small>[2]: In addition to <code>showHidden: boolean</code> from Node.js, <strong>showify</strong> also provides an <code>"exclude-meta"</code> option, which behaves like <code>true</code> but removes common meta properties like the <code>length</code> property of arrays from the output.</small></div>
123+
<div><small>[3]: Whether to treat getters/setters specially. Getters may throw errors, so it’s important to account for such cases.</small></div>
124+
<div><small>[4]: <code>Promise</code> objects are displayed as <code>Promise { &lt;state unknown&gt; }</code>, since it’s impossible to determine the state of a <code>Promise</code> without awaiting it.</small></div>
125+
<div><small>[5]: <code>WeakMap</code> and <code>WeakSet</code> objects are displayed as <code>${className} { &lt;items unknown&gt; }</code> even when <code>showHidden</code> is <code>"always"</code>, since it’s impossible to retrieve the values of a <code>WeakMap</code> or <code>WeakSet</code> without knowing the keys.</small></div>
126+
</p>
125127

126128
Aside from the features listed above, **showify** also supports many more special cases than other libraries, such as wrapper objects for primitives (e.g., `new String("foo")`), async/generator functions, ES6 classes, and more.
127129

0 commit comments

Comments
 (0)