Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added chained function documentation to reference #8

Merged
merged 2 commits into from
Jul 20, 2023
Merged

Added chained function documentation to reference #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e6bd30
Added documentation for the chained function operator.
callendorph Jul 20, 2023
1641d26
[bugfix] fixed some spelling mistakes
callendorph Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/reference.gen
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,23 @@ calc-mortgage{_, 75.00} $
base-price()
\#}}

\subsubheader{Chained Function Operator '$>'}
The following operator allows the functions \code{func1} and \code{func2} to be called in sequence (chained). The input value \code{some-input} is passed as the argument to \code{func1}. \code{func1} is invoked and the output is applied as the argument to \code{func2}.
\code{
some-input $> func1 $> func2
}

Example:

\code{\#{
stanza> val data = [" what", "a wonderful", "world. "]
stanza> val msg = data $> string-join{_, " "} $> trim $> upper-case
stanza> println(msg)
WHAT A WONDERFUL WORLD.
\#}}

Here a tuple of strings is joined, trimmed of white-space, and converted to uppercase letters in a chained sequence of operations.

\subsubheader{If Conditionals}
The following form evaluates one of two branches depending on whether the predicate \code{p} is \code{true} or \code{false}.
\code{
Expand Down Expand Up @@ -3504,7 +3521,7 @@ defn delete-file (path:String) -> False
}

\subsubheader{delete-recursive}
This function deletes the given path and if it is a directory, recursively delets all files and directories inside that directory. If the \code{folow-symlinks?} argument is \code{true}, then any symlinks encountered during the descent will be followed and if the symlink points to a directory, the source of the symlink will also be deleted. Symlinks that point to other files will only delete the symlink and not the source file.
This function deletes the given path and if it is a directory, recursively deletes all files and directories inside that directory. If the \code{follow-symlinks?} argument is \code{true}, then any symlinks encountered during the descent will be followed and if the symlink points to a directory, the source of the symlink will also be deleted. Symlinks that point to other files will only delete the symlink and not the source file.
\code{
defn delete-recursive (path:String, follow-symlinks?:True|False) -> False
}
Expand Down
Loading