From a656dbd6cd9d607b5f75347bf405f1a9cdae47db Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Sat, 16 Jan 2021 16:08:56 +0000 Subject: [PATCH 1/4] README: more informative intro sentence Also link to the pre-announcement Discourse post/thread, and unwrap the only line that was hard-wrapped in the document. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5fa4905..2417ae1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Chain.jl -Even more convenient than pipes. +A [Julia package](https://julialang.org/packages/) for chaining function calls using a more convenient syntax than Julia's native [piping functionality](https://docs.julialang.org/en/v1/manual/functions/#Function-composition-and-piping). @@ -89,6 +89,8 @@ This is very useful to inspect pipeline state during debugging, for example. - Because everything is just lines with separate expressions and not one huge function call, IDEs can show exactly in which line errors happened - Pipe is a name defined by Base Julia which can lead to conflicts +For more details, see the [pre-announcement post](https://discourse.julialang.org/t/rfc-pipelesspipes-jl-now-chain-jl/50448). + ## Example An example with a DataFrame: @@ -119,8 +121,7 @@ end ## Alternative one-argument syntax -If your initial argument name is long and / or the chain's result is assigned to a long -variable, it can look cleaner if the initial value is moved into the chain. +If your initial argument name is long and / or the chain's result is assigned to a long variable, it can look cleaner if the initial value is moved into the chain. Here is such a long expression: ```julia From 31305493640850318e3173e90afb218fc25d4b1c Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Sat, 16 Jan 2021 16:23:11 +0000 Subject: [PATCH 2/4] README: Link names of alternative tools --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2417ae1..95e2055 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,8 @@ df |> - + +
Chain.jlBase Julia
Pipe.jlLazy.jlPipe.jlLazy.jl
From c9b6ba5306a31ab6f5fca2b673659c8347741fda Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Sun, 17 Jan 2021 08:54:34 +0000 Subject: [PATCH 3/4] README: correctly describe package --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 95e2055..88f9530 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Chain.jl -A [Julia package](https://julialang.org/packages/) for chaining function calls using a more convenient syntax than Julia's native [piping functionality](https://docs.julialang.org/en/v1/manual/functions/#Function-composition-and-piping). +A [Julia package](https://julialang.org/packages/) for piping a value through a series of transformation expressions using a more convenient syntax than Julia's native [piping functionality](https://docs.julialang.org/en/v1/manual/functions/#Function-composition-and-piping). From 9a171ee3b8a1cbe68630a2c62adcdd0bba8baa8e Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Sun, 17 Jan 2021 08:56:24 +0000 Subject: [PATCH 4/4] README: remove link to pre-announcement post --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 88f9530..ddf1c26 100644 --- a/README.md +++ b/README.md @@ -90,8 +90,6 @@ This is very useful to inspect pipeline state during debugging, for example. - Because everything is just lines with separate expressions and not one huge function call, IDEs can show exactly in which line errors happened - Pipe is a name defined by Base Julia which can lead to conflicts -For more details, see the [pre-announcement post](https://discourse.julialang.org/t/rfc-pipelesspipes-jl-now-chain-jl/50448). - ## Example An example with a DataFrame:
Chain.jlBase Julia