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.

Sign up for GitHub

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

WIP: Update docs: refining use of word "parameter" vs "argument" #3138

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

WIP: Update docs: refining use of word "parameter" vs "argument" #3138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _style/naming-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,10 +363,10 @@ going beyond a few lines. Few local names are used (including
parameters), and so there is no need to contrive long, descriptive
names. This convention substantially improves the brevity of most Scala
sources. This in turn improves readability, as most expressions fit in
one line and the arguments to methods have descriptive type names.
one line and the parameters for methods have descriptive type names.

This convention only applies to parameters of very simple methods (and
local fields for very simply classes); everything in the public
interface should be descriptive. Also note that the names of arguments
interface should be descriptive. Also note that the names of parameters
are now part of the public API of a class, since users can use named
parameters in method calls.