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.

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

Use "parameter" and "argument" appropriately #1911

Closed
8 tasks done
cuihtlauac opened this issue Jan 10, 2024 · 3 comments
Closed
8 tasks done

Use "parameter" and "argument" appropriately #1911

cuihtlauac opened this issue Jan 10, 2024 · 3 comments
Labels
bug Something isn't working documentation good first issue Good for newcomers help wanted

Comments

@cuihtlauac
Copy link
Collaborator

cuihtlauac commented Jan 10, 2024

An argument is a value passed to a function. This is at function application.

A parameter is a value a function expects. This is at function definition.

Example:

# let sum u = List.fold_left ( + ) 0 u;;
val sum : int list -> int = <fun>

Function sum has an argument called u. Function List.fold_left is applied to three parameters: ( + ), 0 and u.

This is wrong, it should be:

Function sum has a parameter called u. Function List.fold_left is applied to three arguments: ( + ), 0 and u.

This issue is about checking if the words “parameter” and “argument” are used correctly throughout the tutorials. Whenever any of those terms is used, check if it is the right one; if it is not substitute with the other.

Documents in scope (in urgency order).

  1. A Tour of Ocaml (doc) Use parameter and argument appropriately in a tour of ocaml #1929
  2. [Your First Ocaml Program] (../blob/main/data/tutorials/getting-started/1_02_your_first_ocaml_program.md) Not an issue
  3. Values and Functions (doc) Use parameter and argument appropriately in Values and Functions #1930
  4. Basic Data Types and Pattern Matching (doc) Use parameter and argument appropriately in Basic Data Types And Pattern Matching #1931
  5. Lists (doc) Use parameter and argument appropriately in Lists #1932
  6. Mutability, Loops and Imperative Programming Use parameter and argument appropriately in Mutability, Loops, and Imperative Programming #1933
  7. Options (doc) Use parameter and argument appropriately in Options #1934
  8. Arrays (doc) Use parameter and argument appropriately in Arrays #1935

Do not review the following documents (deprecated, external or rewrite ongoing):

  • Labelled & Optional Arguments
  • Functional Programming
  • If Statements and Recusions
  • Modules
  • Functors
  • Any CS3110 or RWO ones
@cuihtlauac cuihtlauac added bug Something isn't working good first issue Good for newcomers documentation labels Jan 10, 2024
@PoorlyDefinedBehaviour
Copy link
Contributor

Working on it

@PoorlyDefinedBehaviour
Copy link
Contributor

The words parameter and argument do not appear in Your First Ocaml Program. It can be removed from the todo list.

@sabine
Copy link
Collaborator

sabine commented Jan 16, 2024

All complete

@sabine sabine closed this as completed Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation good first issue Good for newcomers help wanted
Projects
Archived in project
Development

No branches or pull requests

3 participants