Skip to content

Sum-of-multiples: Add information to the description. #961

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 5 commits into from
Nov 9, 2017

Conversation

hekrause
Copy link
Contributor

@hekrause hekrause commented Oct 17, 2017

Changes for Issue exercism/rust#360

@rpottsoh rpottsoh changed the title Added further informations in the description. Sum-of-multiples: Add information to the description. Oct 17, 2017
@NobbZ
Copy link
Member

NobbZ commented Oct 18, 2017

I've edited the OP to make clear it's referencing a ticket in another repository. I was confused at first when I followed the link...

@@ -5,3 +5,5 @@ If we list all the natural numbers up to but not including 20 that are
multiples of either 3 or 5, we get 3, 5, 6 and 9, 10, 12, 15, and 18.

The sum of these multiples is 78.

PS: Notice that multiples of both 3 and 5 like for example 15 will counted only once.
Copy link
Member

Choose a reason for hiding this comment

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

This post scriptum feels out of place (well, thats what post scriptums always do).

I'd prefer to add the word "unique" as a qualifier to the first sentence:

Given a number, find the sum of all the unique multiples of particular numbers up to
but not including that number.

(emphasis to make the difference clear, not to be added into the description)

@Insti
Copy link
Contributor

Insti commented Oct 18, 2017

@hekrause: It would be more useful if the description of the problem and the change that is being made to solve that problem were a part of the pull request, rather than requiring reviewers to hunt down a rabbit hole of links to work out what was going on.

@hekrause
Copy link
Contributor Author

@Insti In exercism/rust#360 @petertseng mentioned that the solution to this issue should better be handled in the problem-specification repository and not in the language specific rust repo.

So I made one link directly to the issue where the problem is explained. "hunt down a rabbit hole" is a bit much :-)

But for future issues and pull request I will keep that in mind.

@NobbZ
Copy link
Member

NobbZ commented Oct 18, 2017

Even if it is only a single link, a short recap is always a nice thing.

@Insti
Copy link
Contributor

Insti commented Oct 18, 2017

So I made one link directly to the issue where the problem is explained. "hunt down a rabbit hole" is a bit much :-)

I apologise, I guess I was a bit cranky earlier, sorry, this was not your fault.
I was not as friendly and welcoming as I would like to be.

for future issues and pull request I will keep that in mind.

Thanks. ❤️

@petertseng
Copy link
Member

all right, all right, for bookkeeping reasons I will Request Changes (in the GitHub sense), though it may be that the requested change is simply to comment "we don't need to keep the two in sync"

Copy link
Member

@petertseng petertseng left a comment

Choose a reason for hiding this comment

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

Should this be added to https://github.com/exercism/problem-specifications/blob/master/exercises/sum-of-multiples/metadata.yml#L2 as well? It doesn't necessarily have to be, but since the sentences are currently the same, if we choose now to make them diverge we should make sure the decision is deliberate.

@Insti
Copy link
Contributor

Insti commented Oct 27, 2017

I do not think the blurb in metadata.ymlneeds updating. The sentences are only the same through historical accident. The blurb only needs to be an overview of the problem which the current blurb mostly is. Extra implementation details need only be included in the description.md

disclaimer: I'm also slightly against the word 'unique' being added to the description.
I think it makes the sentence more confusing and I'd rather see the description re-written for better clarity. But do not feel-strongly enough about this to object to 'unique' being added.

@Insti
Copy link
Contributor

Insti commented Oct 27, 2017

The Exercism description unhelpfully focuses on the multiples of particular numbers in relation to another unrelated number which is actually the limit of a range.

Given a number, find the sum of all the multiples of particular numbers up to but not including that number.

The Project Euler problem this exercise is based on does not have this issue:

If we list all the natural numbers below 10 that are multiples of 3 or 5, we get 3, 5, 6 and 9. The sum of these multiples is 23.
Find the sum of all the multiples of 3 or 5 below 1000.

The Exercism blurb and description should be re-written to improve clarity.

@petertseng petertseng dismissed their stale review October 27, 2017 09:38

"we should make sure the decision is deliberate". We now have.

but not including that number.

If we list all the natural numbers up to but not including 20 that are
multiples of either 3 or 5, we get 3, 5, 6 and 9, 10, 12, 15, and 18.
If we list all the natural numbers below 20 that are multiples of 3 or 5, we get 3, 5, 6 and
Copy link
Member

Choose a reason for hiding this comment

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

I think the "and" after 6 should be removed:

"multiples of either 3 or 5, we get 3, 5, 6, 9, 10, 12, 15, and 18."

but not including that number.

If we list all the natural numbers up to but not including 20 that are
multiples of either 3 or 5, we get 3, 5, 6 and 9, 10, 12, 15, and 18.
If we list all the natural numbers below 20 that are multiples of 3 or 5, we get 3, 5, 6, 9, 10, 12, 15, and 18.
Copy link
Member

Choose a reason for hiding this comment

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

I've just remembered that we should break lines at 80 columns. Could you perhaps fix that?

@ErikSchierboom ErikSchierboom merged commit 6fb7833 into exercism:master Nov 9, 2017
@ErikSchierboom
Copy link
Member

Merged. Thanks @hekrause!

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.

5 participants