-
Notifications
You must be signed in to change notification settings - Fork 1k
Grammar and wording changes to 'Basics' page. #1579
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
Merged
Merged
Changes from 48 commits
Commits
Show all changes
49 commits
Select commit
Hold shift + click to select a range
e767bbd
Add colon before list
212dca7
Change ordered list to unordered list as items do not represent a seq…
e52b959
Change 'either' to 'whichever'
85af57b
Capitalise first letter of item in a list
702e32f
Add 'by' to clarifymeaning
1d8fe41
Add colon before a list
7f4efb3
Add missing word, and add a comma and a 'for' for clarity
af2b2e3
Change html lists to markdown for consistency with other lists
629075a
Change 'set up' verb to 'setup' adjective
761ca7d
Change 'smoothly' integrates to 'seamlessly' integrates, as 'seamless…
b47dd26
Flesh out the word 'that', to provide more clarity
8b1fdce
Change 'behavior' to 'behaviors' for clarity, as it may seem like al…
9d9a2b5
Change sentence slightly to clarify that subclassing and mixins are t…
1a4956b
Add it for consistency with the rest of the list
96711b4
Add missing word
46d0daf
Capitalise first letter of items in a list
d2e90e0
Change use of 'easy' and 'smoothly' to 'straightforward', as these tw…
06ab742
Change 'smooth' to 'seamless'
22b3f49
Change 'close' to 'closely', as 'close' relates to location in physic…
875ce74
Change grammar; should be 'as' instead of 'with'
5892a23
Remove reference to contents menu to prevent information overload; th…
41d2729
Add a colon directly preceding a list
e38d984
Remove unnecessary comma from list item
4991195
Add missing word
e0ec662
Add a colon before a list
ddf423d
Change words to increase clarity
627a552
Rearrange wording to increase clarity. Italicise 'ScalaFiddle'
0f9e44c
Italicise 'ScalaFiddle'. Reorganise sentences to group similar inform…
b03bf63
Add a colon when introducing a code example
7d66392
Add words for clarity and consistency
26e491b
Add more clarity around type inference
8e1428a
Add more clarity around type inference
c692abc
Update description of scala functions.
2567d1c
Add clarity to anonymous function description
6902608
Change 'parameter' to 'argument'
25bfca3
Change 'parameter' to 'argument'
121e24e
Add parenthesis around 's' to clarify that multiple parameter lists a…
d5ace9e
Remove redundancy of having the word 'colon' followed by the colon pu…
3279cbf
Clarify the description of 'Unit'
52e065b
Flesh out the definition of case classes
ba03182
Add missing word
4c50787
Add clarity to case class comparison
1671d4e
Add missing word
48f1e8f
Flesh out the description of traits for clarity
675528b
Clarify the definition of a main method
bcf565c
Tidy up: add commas and clarifications
b13084c
Remove contractions
7502ee9
Make changes requested in PR comments
006dafc
Merge branch 'master' into basics
SethTisue File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is redundant. Having parameters is equivalent to taking arguments. The original is better. (Also, functions can take zero arguments, so the statement isn't even correct either way, but the new one is worse than the old one.)
Also, although "arguments" is more standard terminology, the parameters are called parameters in Scala, so it's probably better to leave it alone.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I take your point about the functions having zero arguments, but the original statement saying a function can "take" parameters doesn't make sense either.
A function has parameters. When it says functions "take" parameters it sounds like "parameters" can be passed in. Arguments can be passed in, parameters can't.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough, but I don't think the clarity of the text should rely upon the reader understanding that arguments are the passed-in version of parameters.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If a reader sees "functions can take parameters", they might wonder about the quality, and accuracy of the Scala documentation as a whole.
The information should be made as accurate as possible, regardless of the reader's level of understanding.
I think this a (living) language thing. Some languages call them two different types of parameters; English calls them parameters and arguments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to merge the PR regardless, but I lean more towards Rex's side here. I invite anyone interested to submit a followup PR with a different wording that we all like?