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

two-bucket: metadata: make title singular #2126

Merged
merged 1 commit into from
Oct 12, 2022
Merged

Conversation

ee7
Copy link
Member

@ee7 ee7 commented Oct 11, 2022

Follow-up from #2122 (comment)

@ee7 ee7 requested a review from kytrinyx October 11, 2022 08:34
@siebenschlaefer
Copy link
Contributor

I'm not a native English speaker, but shouldn't "buckets" be plural because there's two?

@kytrinyx
Copy link
Member

I'm not a native English speaker, but shouldn't "buckets" be plural because there's two?

That is why I got it wrong in the first PR. But the slug is two-bucket, so it would make sense for the name to be singular.

All the tracks that have implemented this exercise have used "Two Bucket" as the name.

(I suppose the name doesn't have to follow the slug exactly, but I feel like we'd need to actually be conscious about that choice).

@siebenschlaefer
Copy link
Contributor

So this title "Two Bucket" doesn't get displayed anywhere where proper grammar is expected? Ok then, I withdraw my objections.

@ee7
Copy link
Member Author

ee7 commented Oct 11, 2022

Should we think about changing the exercise name instead? I don't mind either way.

Some previous exercise renamings:

@kytrinyx
Copy link
Member

I'm okay either way. @ErikSchierboom @iHiD What is the current change process if we decide to change the name?

I imagine:

  • duplicate the exercise and deprecate the old one
  • then potentially change all the tracks to rename two-bucket to two-buckets and give it a new UUID?
  • anything else?

@kytrinyx
Copy link
Member

Wait, I think I misunderstood the suggestion.

There are two options, as I see it:

  1. Change the exercise to be two-buckets (name: Two Buckets). That would mean duplicating, deprecating, etc.
  2. Just have the name of the two-bucket problem to be Two Buckets. That wouldn't require any big overhaul.

If (1) then I prefer to merge this as is and do the duplication/deprecation as a second step.
If (2) then I prefer to just close this PR.

@ee7
Copy link
Member Author

ee7 commented Oct 11, 2022

(And option 0 is to revert to the status quo: keep the slug as two-bucket and the title as Two Bucket).

I was referring to option 1, but option 2 is also worth considering.

With option 2, we already have exactly these precedents for an exercise slug diverging from its title by more than capitalization and hyphens:

  • dnd-character with D&D character
  • paasio with PaaS I/O (raises the question: slug should be paas-io or paas-i-o?)
  • pascals-triangle with Pascal's Triangle

But two-bucket having the title Two Buckets is much more surprising, and the below being correct in track config.json files may cause some confusion:

        "slug": "two-bucket",
        "name": "Two Buckets",

I think my preference is option 1 if it's easy, otherwise 0, then 2. Or option 0 now, with the option to do 1 eventually if convenient.

@kytrinyx
Copy link
Member

I've dug into this and I think option 1 is easy enough. I would be happy to do the work to move all tracks to using the new exercise.

As such, I'd like to merge this PR, then I'll open a new one to deprecate two-bucket and implement two-buckets.

@ee7
Copy link
Member Author

ee7 commented Oct 11, 2022

Sounds good to me.

So we can't just rename the exercise in prob-specs like we did in the past, and we need to add exercises/two-bucket/.deprecated in this repo?

@kytrinyx
Copy link
Member

So we can't just rename the exercise in prob-specs like we did in the past, and we need to add exercises/two-bucket/.deprecated in this repo?

@ee7 Yeah, not since we reopened the repository for changes.

@petertseng
Copy link
Member

If someone forced me to come up with an argument as to why it should stay two bucket, the argument I'd use is that the https://en.wikipedia.org/wiki/Three-body_problem is called the three-body problem, not the three bodies problem, and therefore in the same vein this problem should be called the two bucket problem instead of the two buckets problem.

Fortunately, I am not being forced to argue for two bucket by anyone or anything, so it's just whatever consensus decides here.

@kytrinyx
Copy link
Member

@petertseng Had it been "The Two Bucket Problem" I would agree with you. Without "Problem" or "Solution" tacked on, though, I do think "Two Buckets" sounds more correct. The current description doesn't talk about "The Two Bucket Problem", mentioning "two buckets".

Having said all of that... this exercise has existed since 2014 and nobody has ever complained about the title being singular. The only reason this has turned into a discussion is that I was trying to make all titles consistent and accidentally wrote "Two Buckets" when it should have been "Two Bucket".

As I said before, I don't really feel strongly either way about this one, I just want the title to be explicitly defined so that we nudge tracks in the direction of consistency.

@ErikSchierboom
Copy link
Member

My personal vote would be for option 2: having the title be different from the exercise's slug. I don't really mind that,

@iHiD
Copy link
Member

iHiD commented Oct 12, 2022

To chime in from a website perspective, I'm pretty against deprecating/duplicating the exercise in the track repos, as that will mean everyone who's completed it gets a duplicate exercise in their history, and has to redo the same work on a new exercise, which feels like a bad user experience.

So I think from a track-repo perspective the slug should just be updated with the uuid remaining the same. But that sounds like manual work for all the tracks, some of which may be scriptable, but some of which won't be (e.g. for tracks where directory names are with code (e.g. TwoFer.foo must be in a dir called two_fer) there's manual code changes).

All of which makes me feel the churn factor here isn't worth changing the slug.

@kytrinyx
Copy link
Member

All of which makes me feel the churn factor here isn't worth changing the slug.

Yeah, agreed.

Okay, I'm going to call it:

  • We're not going to duplicate and deprecate.
  • Whichever way we go, there's potential for someone to get slightly confused, either by the slug being mismatched to the title, or the title not being grammatically correct.
  • It's been Two Bucket since 2014 with nobody raising it as an issue.

I'm going to go ahead and decide that we will continue to have the slug and title that we've had since 2014: two-bucket and Two Bucket (singular).

@kytrinyx kytrinyx merged commit c54da49 into main Oct 12, 2022
@kytrinyx kytrinyx deleted the two-bucket-metadata branch October 12, 2022 13:52
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.

6 participants