Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hoishing committed Aug 17, 2024
1 parent 64fd45d commit f4375bd
Show file tree
Hide file tree
Showing 23 changed files with 190 additions and 2,455 deletions.
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# pipable
# Pipable

[![ci-badge]][ci-url] [![pypi-badge]][pypi-url] [![MIT-badge]][MIT-url] [![black-badge]][black-url]

> pipe operation in python
- [docs](https://hoishing.github.io/pipable)

## Quick Start

### Create the Pipe Object
Expand Down Expand Up @@ -92,6 +90,8 @@ def concat(**kwargs):
dict(b="boy", c="cat") << concat # "b-boy, c-cat"
```

- refer the [docs](https://hoishing.github.io/pipable/reference) for details

## Motivation

Pipe operation is a handy feature in functional programming. It allows us to:
Expand All @@ -108,7 +108,7 @@ There are packages, such as [pipe] take the similar approach. It works great wit

How can I assign value to the first argument?

Assign it within a wrapper function
use a wrapper function

```python
square = Pipe(lambda x: pow(x, 2))
Expand Down Expand Up @@ -146,18 +146,21 @@ def wrapper(first, others):

## Need Help?

Open a [github issue] or ping me on [Twitter ![twitter-icon]][Twitter]
[![git-logo] github issue][github issue]

[github issue]: https://github.com/hoishing/pipable/issues
[Twitter]: https://twitter.com/hoishing
[twitter-icon]: https://api.iconify.design/logos/twitter.svg?width=20
[![x-logo] posts][x-post]

[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-url]: https://github.com/psf/black
[ci-badge]: https://github.com/hoishing/pipable/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/hoishing/pipable/actions/workflows/ci.yml
[Coconut]: https://github.com/evhub/coconut
[git-logo]: https://api.iconify.design/bi/github.svg?color=%236FD886&width=20
[github issue]: https://github.com/hoishing/pipable/issues
[MIT-badge]: https://img.shields.io/github/license/hoishing/pipable
[MIT-url]: https://opensource.org/licenses/MIT
[pipe]: https://pypi.org/project/pipe
[pypi-badge]: https://img.shields.io/pypi/v/pipable
[pypi-url]: https://pypi.org/project/pipable/
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-url]: https://github.com/psf/black
[pipe]: https://pypi.org/project/pipe
[Coconut]: https://github.com/evhub/coconut
[x-logo]: https://api.iconify.design/ri:twitter-x-fill.svg?width=20&color=DarkGray
[x-post]: https://x.com/hoishing
1 change: 0 additions & 1 deletion docs/assets/coverage-badge.svg

This file was deleted.

188 changes: 0 additions & 188 deletions docs/assets/coverage-report.xml

This file was deleted.

Loading

0 comments on commit f4375bd

Please sign in to comment.