Skip to content

crypto-square: Fix description copy and example #929

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
Oct 15, 2017
Merged

crypto-square: Fix description copy and example #929

merged 1 commit into from
Oct 15, 2017

Conversation

nholden
Copy link

@nholden nholden commented Oct 7, 2017

The final example in the crypto-square description is inconsistent with the source of the exercise, the canonical data, and itself. This change does a few things to correct that:

  • While the encoding method is called a "square code," we're really dealing with all sorts of rectangles, squares included. The description gets this right up until the copy before the last example, and this change clarifies that.

  • In both the source of the exercise and the canonical data, when a "chunk" is shorter than the length of a row, a blank space is added to the end of that chunk. This change fixes that in the final example.

  • The copy before the final example says that "spaces should be distributed evenly across the last n rows," but it doesn't explain how. This change specifies that the spaces should be added to the end of each chunk.

Here's a related discussion: #356

The final example in the crypto-square description is inconsistent with
the [source of the
exercise](http://users.csc.calpoly.edu/~jdalbey/103/Projects/ProgrammingPractice.html),
the canonical data, and with itself. This change does a few things to
correct that:

- While the encoding method is called a "square code," we're really
dealing with all sorts of rectangles, squares included. The description
gets this right up until the last example, and this change clarifies
that.

- In both the source of the exercise and the canonical data, when a
"chunk" is shorter than the length of a row, a blank space is added to
the end of that chunk. This change fixes that in the final example.

- The copy before the final example says that "spaces should be
distributed evenly across the last `n` rows," but it doesn't explain
how. This change specifies that the spaces should be added to the end of
each chunk.

Here's a related discussion:
#356
@nholden
Copy link
Author

nholden commented Oct 14, 2017

Is there anything I can do to help get this and #937 merged? I'd like to resolve exercism/ruby#422, and it makes sense to have these two PRs merged before submitting a PR in the Ruby repo.

@Insti
Copy link
Contributor

Insti commented Oct 15, 2017

2 approvals, no objections, I'll merge this.

@Insti Insti merged commit 1c76ad6 into exercism:master Oct 15, 2017
@Insti
Copy link
Contributor

Insti commented Oct 15, 2017

Done, thanks for the bump.
And thanks for doing the changes ❤️

@nholden
Copy link
Author

nholden commented Oct 15, 2017

Thanks, @Insti! 😄

@nholden nholden deleted the fix-crypto-square-description branch October 15, 2017 16:07
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