Skip to content

Commit

Permalink
fix(docs): params before examples
Browse files Browse the repository at this point in the history
  • Loading branch information
tunnckoCore committed Oct 29, 2016
1 parent cb74148 commit 0fd3a4c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ const functionArguments = require('function-arguments')
### [functionArguments](index.js#L33)
> Get function arguments names.
**Params**

* `fn` **{Function}**: Function from which to get arguments names.
* `returns` **{Array}**

**Example**

```js
Expand All @@ -38,11 +43,6 @@ console.log(fnArgs(function * (a ,b, c) {})) // => [ 'a', 'b', 'c' ]
console.log(fnArgs(function * named (a ,b, c) {})) // => [ 'a', 'b', 'c' ]
```

**Params**

* `fn` **{Function}**: Function from which to get arguments names.
* `returns` **{Array}**

### Works when using comments
> As it works for ES2015, it also works if you use comments in weird places.
Expand Down

0 comments on commit 0fd3a4c

Please sign in to comment.