Skip to content

Commit

Permalink
Version 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
davidchambers committed Apr 25, 2015
1 parent 4f06b14 commit 0f35282
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions examples/fp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### [`map :: (a -> b) -> [a] -> [b]`](https://github.com/plaid/transcribe/blob/v0.1.0/examples/fp.js#L4)

Transforms a list of elements of type `a` into a list of elements
of type `b` using the provided function of type `a -> b`.

```javascript
> map(String)([1, 2, 3, 4, 5])
['1', '2', '3', '4', '5']
```

### [`filter :: (a -> Boolean) -> [a] -> [a]`](https://github.com/plaid/transcribe/blob/v0.1.0/examples/fp.js#L24)

Returns the list of elements which satisfy the provided predicate.

```javascript
> filter(function(n) { return n % 2 === 0; })([1, 2, 3, 4, 5])
[2, 4]
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "transcribe",
"version": "0.0.0",
"version": "0.1.0",
"description": "Generate Markdown documentation from code comments",
"license": "MIT",
"homepage": "https://github.com/plaid/transcribe",
Expand Down

2 comments on commit 0f35282

@CrossEye
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very nice to see. I wish we'd invested the energy in something like this before committing to JSDoc for Ramda.

I haven't tried it yet, but looking at it, it seems to be almost exactly what I wanted to do. Kudos!

@davidchambers
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Scott. It's certainly lighter than JSDoc. :)

Please sign in to comment.