Replace argument term with parameter #77

New Issue

2026-10-27T23:13:23+01:00

jakob.scheid commented

2026-10-27 23:13:23 +01:00

Problem

In the project, the term argument is often used to refer to parameters. However, arguments are specific values that are passed to a function when it is called. Parameters, which are actually what is meant here, are simply the variable declarations in a function definition. Parameter is the more appropriate term to use in this case, not argument. Examples for incorrect use of the term argument are:

PythonArgumentStructureError
PythonFunctionArgument
the jcloud_docsgen.core.python.arguments module
var-keyword argument (correct: variadic keyword parameter)
vararg (correct: variadic positional parameter, even though the term vararg is commonly used)
_group_argument_list function

…and many more.

It is important to distinguish between these two terms, since the project documentation should be technically accurate, especially since this is a meta-level tool.

Goal

A clear distinction is made arguments and parameters and the two terms are used correctly. All function, class, and module names and all docstrings which use an incorrect term are updated.

## Problem In the project, the term *argument* is often used to refer to parameters. However, arguments are specific values that are passed to a function when it is called. Parameters, which are actually what is meant here, are simply the variable declarations in a function definition. *Parameter* is the more appropriate term to use in this case, not *argument*. Examples for incorrect use of the term *argument* are: - `PythonArgumentStructureError` - `PythonFunctionArgument` - the `jcloud_docsgen.core.python.arguments` module - *var-keyword argument* (correct: *variadic keyword parameter*) - *vararg* (correct: *variadic positional parameter*, even though the term *vararg* is commonly used) - `_group_argument_list` function …and many more. It is important to distinguish between these two terms, since the project documentation should be technically accurate, especially since this is a meta-level tool. ## Goal A clear distinction is made arguments and parameters and the two terms are used correctly. All function, class, and module names and all docstrings which use an incorrect term are updated.

jakob.scheid added this to the 0.2.4 milestone 2026-10-27 23:13:23 +01:00

jakob.scheid added the Kind/Documentation

Priority

Medium

3

Compat/Breaking Kind/Refactor labels 2026-10-27 23:13:23 +01:00

jakob.scheid added this to the Project Board project 2026-10-27 23:13:23 +01:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: jCloud/jcloud-docsgen#77