Review descriptions for initial duplication. #802

Insti · 2017-05-23T21:38:38Z

Pull Request #775 prepended a problem's blurb to its description. This resulted in a few descriptions having obvious duplication in the first few lines.

This PR reviews all descriptions and:

Removes gratuitous duplication.
Ensures the first line does not exceed 80 characters.
Fixes a few spelling/grammar errors.
Re-arranges a few descriptions for clarity.
Removes a few occurrences of 'write a program'

Thanks to @ErikSchierboom for pointing many of these out.

Dependency:

Completed - No longer add blurb to readme DEPRECATED.trackler#49. Merging before this is completed may result in the appearance of first line duplication when the readmes for these problems are generated.

Refs:
PR #775
Write a program

Pull Request exercism#775 prepended a problem's blurb to its description. This resulted in a few descriptions having obvious duplication in the first few lines. This PR reviews all descriptions and: * Removes gratuitous duplication. * Ensures the first line does not exceed 80 characters. * Fixes a few spelling/grammar errors. * Re-arranges a few descriptions for clarity. * Removes a few occurrences of 'write a program' Refs: [PR 775](exercism#775) [Write a program](exercism#321)

Insti · 2017-05-23T21:51:18Z

exercises/pangram/description.md

 "every letter") is a sentence using every letter of the alphabet at least once.
-The best known English pangram is "The quick brown fox jumps over the lazy dog."
+The best known English pangram is "The quick brown fox jumps over the lazy
+dog."


Try and avoid line wrapping inside quotes.

Insti · 2017-05-23T21:52:01Z

exercises/perfect-numbers/description.md

@@ -1,4 +1,5 @@
-Determine if a number is perfect, abundant, or deficient based on Nicomachus' (60 - 120 CE) classification scheme for natural numbers.
+Determine if a number is perfect, abundant, or deficient based on Nicomachus'
+(60 - 120 CE) classification scheme for natural numbers.


Try and keep Nicomachus' dates with his name.

ErikSchierboom · 2017-05-24T06:50:50Z

exercises/book-store/description.md

@@ -1,5 +1,3 @@
-To try and encourage more sales of different books from a popular 5 book series, a bookshop has decided to offer discounts of multiple-book purchases.
-


I actually like the removed text better here.

@ErikSchierboom I have been following the discussion here and I agree with you on this point but I would like to add that the hyphen should be removed if multiple is left in. I like multiple book better than multi-book. I never really noticed it before till the topic of consolidation came up.

Replaced and de-hyphened as suggested.

ErikSchierboom · 2017-05-24T08:12:54Z

exercises/diamond/description.md

@@ -1,5 +1,3 @@
-Given a letter, print a diamond starting with 'A' with the supplied letter at the widest point.
-
 ## Diamond kata


Does the heading make sense? It is rarely used elsewhere.

Insti · 2017-05-24T12:43:11Z

exercises/book-store/description.md

-they sell of a popular series, a bookshop has decided to
-offer discounts of multi-book purchases. 
+To try and encourage more sales of different books from a popular 5 book
+series, a bookshop has decided to offer discounts of multiple book purchases.


Should this be "on multiple book purchases"?

rpottsoh · 2017-05-24T13:21:47Z

I think ‘on’ rolls off the tongue better.

Insti · 2017-05-24T18:39:13Z

Barring any huge mistakes we've not found, this is ready to be squashed and merged now.
Further tweaking of descriptions can happen in separate specific PRs.

stkent · 2017-05-29T12:20:07Z

exercises/octal/description.md

@@ -1,4 +1,6 @@
-Convert a octal number, represented as a string (e.g. '1735263'), to its decimal equivalent using first principles (i.e. no, you may not use built-in or external libraries to accomplish the conversion).
+Convert a octal number, represented as a string (e.g. '1735263'), to its


Convert a octal number

should probably read

Convert an octal number

(This exercise is deprecated but likely still served by some tracks, so I figure the change is worth making?)

stkent · 2017-05-29T12:23:12Z

exercises/sum-of-multiples/description.md

@@ -1,4 +1,5 @@
-Given a number, find the sum of all the multiples of particular numbers up to but not including that number.
+Given a number, find the sum of all the multiples of particular numbers up to


This is almost identically repeated at the end of the description. "particular numbers" also seems to be confusing language here.

This is a good point but I'm not going to change this as part of this PR as it is not related to the initial duplication.

stkent · 2017-05-29T12:24:54Z

exercises/bank-account/description.md

@@ -1,4 +1,4 @@
-Simulate a bank account supporting opening/closing, withdraws, and deposits of money. Watch out for concurrent transactions!
+Simulate a bank account supporting opening/closing, withdrawals, and deposits of money. Watch out for concurrent transactions!


Needs formatting for width.

stkent · 2017-05-29T12:25:25Z

exercises/flatten-array/description.md

@@ -1,4 +1,4 @@
-Take a nested list and return a single list with all values except nil/null.
+Take a nested list and return a single flattened list with all values except nil/null.


Needs formatting for width?

Yes, but not initial duplication related.

stkent · 2017-05-29T12:26:00Z

exercises/secret-handshake/description.md

 10000 = Reverse the order of the operations in the secret handshake.
 ```

+Given a decimal number, convert it to the appropriate sequence of events for a secret handshake.


Needs formatting for width.

Yes, but not initial duplication related.

stkent · 2017-05-29T12:26:27Z

exercises/transpose/description.md

 In general, all characters from the input should also be present in the transposed output.
 That means that if a column in the input text contains only spaces on its bottom-most row(s), 
-the corresponding output row should contain the spaces in its right-most column(s).
+the corresponding output row should contain the spaces in its right-most column(s).


Needs formatting for width.

stkent · 2017-05-29T12:26:38Z

exercises/two-bucket/description.md

 - filling one bucket and doing nothing to the other

-Written with <3 at [Fullstack Academy](http://www.fullstackacademy.com/) by [Lindsay](http://lindsaylevine.com).
+Written with <3 at [Fullstack Academy](http://www.fullstackacademy.com/) by [Lindsay](http://lindsaylevine.com).


Needs formatting for width.

stkent · 2017-05-29T12:27:03Z

exercises/protein-translation/description.md

 UAA, UAG, UGA         | STOP
+
+
+Learn more about [protein translation on Wikipedia](http://en.wikipedia.org/wiki/Translation_(biology))


Needs formatting for width.

The rendered view has no width issues?

stkent · 2017-05-29T12:28:41Z

@Insti reviewed as requested!

stkent · 2017-05-29T12:29:27Z

exercises/pangram/description.md

 "every letter") is a sentence using every letter of the alphabet at least once.
-The best known English pangram is "The quick brown fox jumps over the lazy dog."
+The best known English pangram is: 
+"The quick brown fox jumps over the lazy dog."


Could use markdown quote syntax here: >?

Insti · 2017-05-29T18:24:19Z

Thanks @stkent

Does somebody want to approve these changes so I can squash/merge them?

ErikSchierboom · 2017-05-29T18:48:34Z

@Insti looks good to me!

Insti · 2017-05-29T18:52:53Z

Thanks @ErikSchierboom, @rpottsoh & @stkent

I think this completes the separation of blurbs and descriptions.

Any further changes to required to the content of the descriptions can be done as needed.

Insti added the waiting on other tracks label May 23, 2017

Insti mentioned this pull request May 23, 2017

Review updated descriptions. #800

Closed

2 tasks

Insti commented May 23, 2017

View reviewed changes

ErikSchierboom reviewed May 24, 2017

View reviewed changes

Make changes suggested in reviews.

ec4bd2f

Insti commented May 24, 2017

View reviewed changes

Insti removed the waiting on other tracks label May 24, 2017

Discounts "on" multiple book purchases.

1d5258a

Insti added the ready label May 24, 2017

Insti mentioned this pull request May 28, 2017

clock: first two description lines are near-dupes #813

Closed

stkent reviewed May 29, 2017

View reviewed changes

Fixes based on review.

97c3958

ErikSchierboom approved these changes May 29, 2017

View reviewed changes

Insti merged commit 73ebd13 into exercism:master May 29, 2017

Insti deleted the Review_descriptions branch May 29, 2017 18:49

		@@ -1,5 +1,3 @@
		To try and encourage more sales of different books from a popular 5 book series, a bookshop has decided to offer discounts of multiple-book purchases.

		@@ -1,5 +1,3 @@
		Given a letter, print a diamond starting with 'A' with the supplied letter at the widest point.

		## Diamond kata

		@@ -1,4 +1,6 @@
		Convert a octal number, represented as a string (e.g. '1735263'), to its decimal equivalent using first principles (i.e. no, you may not use built-in or external libraries to accomplish the conversion).
		Convert a octal number, represented as a string (e.g. '1735263'), to its

		@@ -1,4 +1,5 @@
		Given a number, find the sum of all the multiples of particular numbers up to but not including that number.
		Given a number, find the sum of all the multiples of particular numbers up to

		@@ -1,4 +1,4 @@
		Simulate a bank account supporting opening/closing, withdraws, and deposits of money. Watch out for concurrent transactions!
		Simulate a bank account supporting opening/closing, withdrawals, and deposits of money. Watch out for concurrent transactions!

		@@ -1,4 +1,4 @@
		Take a nested list and return a single list with all values except nil/null.
		Take a nested list and return a single flattened list with all values except nil/null.

		UAA, UAG, UGA \| STOP


		Learn more about [protein translation on Wikipedia](http://en.wikipedia.org/wiki/Translation_(biology))

Uh oh!

Review descriptions for initial duplication. #802

Review descriptions for initial duplication. #802

Uh oh!

Conversation

Insti commented May 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rpottsoh commented May 24, 2017 via email

Uh oh!

Insti commented May 24, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stkent commented May 29, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Insti commented May 29, 2017

Uh oh!

ErikSchierboom commented May 29, 2017

Uh oh!

Insti commented May 29, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Insti commented May 23, 2017 •

edited

Loading