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

FAQ: minor improvements to functions vs methods #3068

Merged
merged 2 commits into from
Oct 19, 2024

Conversation

SethTisue
Copy link
Member

review by @BalmungSan ?

my initial motivation was to fix a place where Scala 3 was referred to in the future tense. but then while I was there I found I wanted to do some light rewriting

unless you absolutely need a function. And, thanks to
[eta-expansion](https://stackoverflow.com/questions/39445018/what-is-the-eta-expansion-in-scala)
you rarely would need to define a function rather than a method.
Most code uses methods most of the time,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO we should not only note that most code uses methods but also encourage them as the default, given the syntax, performance, etc.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. I see what you mean, but my intent was actually to make the wording stronger, not to weaken it. I think the word "recommend" is sort of weak. Whereas I really want to say quite forcefully, methods are definitely the norm in this language.

Maybe I can find a different wording.

[eta-expansion](https://stackoverflow.com/questions/39445018/what-is-the-eta-expansion-in-scala)
you rarely would need to define a function rather than a method.
Most code uses methods most of the time,
unless a function value is actually needed. With
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In retrospect, we should have added an example, something like:

e.g. you will compose it with other functions using andThen.

Copy link
Member Author

@SethTisue SethTisue Sep 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, good point, I can try to add something like that

you rarely would need to define a function rather than a method.
Most code uses methods most of the time,
unless a function value is actually needed. With
[eta-expansion](https://stackoverflow.com/questions/39445018/what-is-the-eta-expansion-in-scala),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if "With" is the best connector to use.
But, I am not known for my good level of written English 😅 it just feels off to me but that may as well be because I am not a native speaker.

Copy link
Member Author

@SethTisue SethTisue Sep 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually hesitated over that; you're right to call it out.

Thanks for the feedback; I'll ponder some further edits.

@SethTisue
Copy link
Member Author

SethTisue commented Oct 19, 2024

@BalmungSan wdyt now? mergeable?

note that I really don't want to make the answer even longer. FAQ answers should be short. so I'm willing to make further edits but only if they aren't expansions. the entry already links to longer explanations.

@SethTisue SethTisue merged commit 0234fa4 into scala:main Oct 19, 2024
1 check failed
@SethTisue SethTisue deleted the faq-tweak branch October 19, 2024 21:36
@SethTisue
Copy link
Member Author

fixup: cee9851

fResult pushed a commit to fResult/docs.scala-lang that referenced this pull request Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants