This is an automated email from the ASF dual-hosted git repository.
sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new e1e2523 [docs][functions] Remove redundancy (#6138)
e1e2523 is described below
commit e1e252374ed4a9fab9b759391c32005d98bfbad8
Author: EugenDueck <[email protected]>
AuthorDate: Sat Jan 25 12:19:41 2020 +0900
[docs][functions] Remove redundancy (#6138)
### Motivation
*Parts of the docs for Pulsar Functions are redundant.*
### Modifications
*Remove parts of the docs for Pulsar Functions that are redundant.*
---
site2/docs/functions-overview.md | 16 ++++------------
1 file changed, 4 insertions(+), 12 deletions(-)
diff --git a/site2/docs/functions-overview.md b/site2/docs/functions-overview.md
index 37869c0..1942c13 100644
--- a/site2/docs/functions-overview.md
+++ b/site2/docs/functions-overview.md
@@ -164,29 +164,21 @@ Delivery semantics | Description
### Apply processing guarantees to a function
-You can set the processing guarantees for a Pulsar Function when you create
the Function. The [`pulsar-function
create`](reference-pulsar-admin.md#create-1) command applies effectively-once
guarantees to the Function.
+You can set the processing guarantees for a Pulsar Function when you create
the Function. The following [`pulsar-function
create`](reference-pulsar-admin.md#create-1) command creates a function with
effectively-once guarantees applied.
```bash
$ bin/pulsar-admin functions create \
+ --name my-effectively-once-function \
--processing-guarantees EFFECTIVELY_ONCE \
# Other function configs
```
-The available options are:
+The available options for `--processing-guarantees` are:
* `ATMOST_ONCE`
* `ATLEAST_ONCE`
* `EFFECTIVELY_ONCE`
-The following command runs a function in the cluster mode with
effectively-once guarantees applied.
-
-```bash
-$ bin/pulsar-admin functions create \
- --name my-effectively-once-function \
- --processing-guarantees EFFECTIVELY_ONCE \
- # Other function configs
-```
-
> By default, Pulsar Functions provide at-least-once delivery guarantees. So
> if you create a function without supplying a value for the
> `--processingGuarantees` flag, the function provides at-least-once
> guarantees.
### Update the processing guarantees of a function
@@ -196,4 +188,4 @@ You can change the processing guarantees applied to a
function using the [`updat
$ bin/pulsar-admin functions update \
--processing-guarantees ATMOST_ONCE \
# Other function configs
-```
\ No newline at end of file
+```