doc: fix list style (#2823)

This commit is contained in:
迷渡 2019-08-28 21:51:36 +08:00 committed by Ryan Dahl
parent 20739a8111
commit 1d34f11a87

View file

@ -54,6 +54,9 @@ When designing function interfaces, stick to the following rules.
there is only one, and it seems inconceivable that we would add more optional
parameters in the future.
<!-- prettier-ignore-start -->
<!-- see https://github.com/prettier/prettier/issues/3679 -->
3. The 'options' argument is the only argument that is a regular 'Object'.
Other arguments can be objects, but they must be distinguishable from a
@ -65,6 +68,8 @@ When designing function interfaces, stick to the following rules.
This allows the API to evolve in a backwards compatible way, even when the
position of the options object changes.
<!-- prettier-ignore-end -->
```ts
// BAD: optional parameters not part of options object. (#2)
export function resolve(