Issue1114

Title Terminology of Argument/Argument_key vs. Parameter
Priority wish Status chatting
Superseder Nosy List florian, jendrik, malte, silvan, simon
Assigned To Keywords
Optional summary
issue 1113 sparked a discussion about the variable names in the parser and 
plugins part.

Citing Malte: """" in a function call like foo(x=3), the word "argument" should 
only really be used in the context of "3", while "x" is called the "parameter". 
Using the word "argument_key" instead of parameter feels a bit weird because of 
the two words "parameter"/"argument", "parameter" is arguably the more common 
and more widely understood one. So we're avoiding the use of the "normal" word 
parameter by inventing a new, more complex word "argument key". """

The word "argument key" came naturally as it is assigned to the field `key` from 
the struct `ArgumentInfo`.

Refactoring the struct to `ParameterInfo` and the field to `name` is straight 
forward here.

However, moving forward in this fashion lead to class `FunctionArgument` with 
fields `std::string key` and `DecoratedASTNodePtr value`
the "key" should be renamed to "parameter" and the "value" to "argument"... but 
is the name "FunctionArgument" still fitting then, since it is the pair of 
parameter and argument(?)

Created on 2023-09-08.17:36:00 by simon, last changed by simon.

Summary
issue 1113 sparked a discussion about the variable names in the parser and 
plugins part.

Citing Malte: """" in a function call like foo(x=3), the word "argument" should 
only really be used in the context of "3", while "x" is called the "parameter". 
Using the word "argument_key" instead of parameter feels a bit weird because of 
the two words "parameter"/"argument", "parameter" is arguably the more common 
and more widely understood one. So we're avoiding the use of the "normal" word 
parameter by inventing a new, more complex word "argument key". """

The word "argument key" came naturally as it is assigned to the field `key` from 
the struct `ArgumentInfo`.

Refactoring the struct to `ParameterInfo` and the field to `name` is straight 
forward here.

However, moving forward in this fashion lead to class `FunctionArgument` with 
fields `std::string key` and `DecoratedASTNodePtr value`
the "key" should be renamed to "parameter" and the "value" to "argument"... but 
is the name "FunctionArgument" still fitting then, since it is the pair of 
parameter and argument(?)
Messages
msg11536 (view) Author: simon Date: 2024-01-29.12:26:26
relevant comment in:
https://github.com/aibasel/downward/pull/179
History
Date User Action Args
2024-01-29 12:26:26simonsetstatus: unread -> chatting
messages: + msg11536
2023-09-27 11:10:40silvansetnosy: + silvan
2023-09-08 17:36:00simoncreate