Skip to content

Revert "Scope of name" #2658

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 1 commit into from
Dec 15, 2022
Merged

Revert "Scope of name" #2658

merged 1 commit into from
Dec 15, 2022

Conversation

SethTisue
Copy link
Member

@SethTisue SethTisue commented Dec 12, 2022

This reverts commit f19728c.

For context, see my remarks about the scope of the FAQ at #2657 .

This reverts commit f19728c.
@SethTisue SethTisue mentioned this pull request Dec 12, 2022
@julienrf
Copy link
Contributor

Since 'name' is a common setting, I think it would be helpful to still have a sentence saying that it is always scoped to a project and not to a wider scope such as the build or the global scope.

@SethTisue
Copy link
Member Author

SethTisue commented Dec 12, 2022

@julienrf in all these years, I have never seen or heard anyone ask about the scoping of name? whereas the original FAQ entry is very much something that comes up over and over and over again with real users

I think we should resist the urge to include tangentially related, possibly-relevant, possibly-irrelevant information in the FAQ and stick only to concisely presenting only the highest-value information — even if that information is a link to relevant documentation with a fuller discussion of nuances and alternate scenarios

I think that's an especially good guideline to apply in this case since when you get the scoping of name wrong, sbt warns you; the user won't be at sea. in theory, they might not know what the warning means, and in theory, they might come to our chat rooms and forums to ask what it means, but in practice I have not observed any such users to exist

cc @som-snytt

@som-snytt
Copy link
Contributor

FTR, I added info that I ask frequently. Finding it in the docs is non-trivial. I think this one was, what's the simplest build.sbt without remembering how to use the giter8 thing or whatever it's cleverly called. When I followed the FAQ, I got it wrong.

I agree the FAQ should be relatively short and sweet. Maybe it can have "more details" links or folds.

By the time we settle on an ideal compromise of pithy vs complete, we'll be able to ask ChatGPT.

@SethTisue
Copy link
Member Author

Maybe it can have "more details" links

Absolutely — always desirable.

@SethTisue
Copy link
Member Author

what's the simplest build.sbt

I think that's a remarkably subtle and even contentious question. I often use none at all, or only a bare scalaVersion setting. https://www.scala-sbt.org/1.x/docs/sbt-by-example.html shows a sample progression.

Setting organization, name, and version is only necessary or desirable if you're going to publish, and publishing is a big subject that's already well covered by https://www.scala-sbt.org/1.x/docs/Publishing.html , I think.

@som-snytt
Copy link
Contributor

som-snytt commented Dec 12, 2022

I think I had to test something locally, so I had to publish an example jar locally. I have read the linked quick-start, but sbt docs are long-form reading. After years of "how do I?" with sbt, I still dread trying to find the one line of doc to tell me something.

get the scoping of name wrong, sbt warns you

The other goal is to help people before they throw the laptop across the room.

If I think of a place for this info, I'll resubmit for your approval.

@SethTisue SethTisue merged commit 7d5d132 into scala:main Dec 15, 2022
@SethTisue SethTisue deleted the shorten-sbt-answer branch December 15, 2022 22:27
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.

3 participants