openfaas / openfaas/docs

Typo in docs/reference/async.md

Open
#240 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
67
Forks
94
Avg merge
5h 51m
Merged PRs (30d)
1

Description

The Parallelism section of the Async documentation currently contains "Should you wish to restrict concurrenty for certain functions". Concurrenty is not a word.

Proposed change

The word concurrenty should be changed to concurrency.

-> Alternatively you can increase the parallelism by setting the queue worker's "max_inflight" option to a value greater than one. This will cause the queue-worker to concurrently receive up to max_inflight many messages and simultaneously invoke their corresponding functions. Should you wish to restrict concurrenty for certain functions, please make use of  [multiple queues](#Multiple-queues) and separate these functions accordingly. When scaling up a queue worker, please be aware that you will get up to 'n * max_inflight' parallel function invocations.
+> Alternatively you can increase the parallelism by setting the queue worker's "max_inflight" option to a value greater than one. This will cause the queue-worker to concurrently receive up to max_inflight many messages and simultaneously invoke their corresponding functions. Should you wish to restrict concurrency for certain functions, please make use of  [multiple queues](#Multiple-queues) and separate these functions accordingly. When scaling up a queue worker, please be aware that you will get up to 'n * max_inflight' parallel function invocations.

Context

Your Environment

  • FaaS-CLI version ( Full output from: faas-cli version ):
    N/A

  • Docker version docker version (e.g. Docker 17.0.05 ):
    N/A

  • Are you using Docker Swarm or Kubernetes (FaaS-netes)?
    N/A

  • Operating System and version (e.g. Linux, Windows, MacOS):
    N/A (Linux Fedora 31)

  • Link to your project or a code example to reproduce issue:
    N/A

  • Please also follow the troubleshooting guide and paste in any other diagnostic information you have:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open docs/reference/async.md and find the Parallelism section. Confirm the typo in “concurrenty,” change it to “concurrency,” and review the surrounding Markdown to ensure the documentation remains unchanged otherwise.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.