Skip to content

Rework two-fer documentation #2204

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Mar 2, 2023
Merged

Rework two-fer documentation #2204

merged 4 commits into from
Mar 2, 2023

Conversation

kytrinyx
Copy link
Member

@kytrinyx kytrinyx commented Feb 20, 2023 •
edited
Loading

This PR is part of our project of making our Practice Exercises more consistent and human. For more context please see this forum thread

We will merge this PR in roughly 72 hours, and then submit PRs to all tracks that have this exercise.

The main changes for this exercise are:

  • Provide background for the idea of two-fer for those who aren't familiar with it.
  • Add an example situation as the context for the exercise.

Closes #1470

BethanyG
BethanyG reviewed Feb 20, 2023
View reviewed changes
BethanyG
BethanyG approved these changes Feb 20, 2023
View reviewed changes
Copy link
Member

@BethanyG BethanyG left a comment

Choose a reason for hiding this comment

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

Comment is a suggestion and not a requirement. 🙂

@kytrinyx
Rework two-fer documentation
c651f3f 
This splits two-fer into separate introduction and instructions
documents.

It also rewords the exercise to feel a bit less stilted, and
(hopefully) a bit more friendly. It adds a bit of explanation
for the definition of the term two-fer and where it comes from,
as well as providing a bit of context ("story", if you will) for
the exercise itself.
ee7
ee7 approved these changes Feb 23, 2023
View reviewed changes
kytrinyx and others added 2 commits February 24, 2023 08:26
@kytrinyx @ee7
Update exercises/two-fer/introduction.md
5525e02 
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
@kytrinyx
Tweak two-fer docs
329e432 
Give a less socially awkward reason for saying 'you'.
@kytrinyx kytrinyx requested a review from a team as a code owner February 27, 2023 11:33
@kytrinyx
Copy link
Member Author

@ErikSchierboom @ee7 @iHiD @BethanyG I changed the reason for saying you to be less socially awkward. Would you give this one last look, to see if this makes sense?

ee7
ee7 reviewed Feb 27, 2023
View reviewed changes
Copy link
Member

@ee7 ee7 left a comment

Choose a reason for hiding this comment

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

Looking good. One more suggestion.

@kytrinyx @ee7
Update exercises/two-fer/instructions.md
bc26086 
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
ErikSchierboom
ErikSchierboom approved these changes Mar 2, 2023
View reviewed changes
Copy link
Member

@ErikSchierboom ErikSchierboom left a comment

Choose a reason for hiding this comment

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

I like it!

@kytrinyx
Copy link
Member Author

kytrinyx commented Mar 2, 2023

Alright, it seems like we're good on this one. I'm going to go ahead and merge it, and if anyone has any further concerns, please open a PR to suggest changes.

@kytrinyx kytrinyx merged commit 8732076 into main Mar 2, 2023
@kytrinyx kytrinyx deleted the two-fer-rewrite branch March 2, 2023 12:33
kytrinyx added a commit to exercism/swift that referenced this pull request Mar 3, 2023
@kytrinyx
Sync two-fer docs with problem-specifications
2d4efd1 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/vlang that referenced this pull request Mar 3, 2023
@kytrinyx
Sync two-fer docs with problem-specifications
e7eaab5 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
@kytrinyx kytrinyx mentioned this pull request Mar 3, 2023
Merged
kytrinyx added a commit to exercism/scheme that referenced this pull request Mar 3, 2023
@kytrinyx
Sync two-fer docs with problem-specifications
c866c21 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
@kytrinyx kytrinyx mentioned this pull request Mar 3, 2023
Merged
kytrinyx added a commit to exercism/zig that referenced this pull request Mar 3, 2023
@kytrinyx
Sync two-fer docs with problem-specifications
7032de4 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
@kytrinyx kytrinyx mentioned this pull request Mar 3, 2023
Merged
kytrinyx added a commit to exercism/perl5 that referenced this pull request Mar 3, 2023
@kytrinyx
Sync two-fer docs with problem-specifications
233fa84 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
This was referenced Mar 3, 2023
Merged
Merged
kytrinyx added a commit to exercism/go that referenced this pull request Mar 3, 2023
@kytrinyx
Sync two-fer docs with problem-specifications
df4dce6 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
rpottsoh pushed a commit to exercism/delphi that referenced this pull request Mar 10, 2023
@kytrinyx @rpottsoh
Sync two-fer docs with problem-specifications
9763d49 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kotp pushed a commit to exercism/perl5 that referenced this pull request Mar 11, 2023
@kytrinyx @kotp
Sync two-fer docs with problem-specifications
4017429 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
@samtygier
Copy link

Sorry this is a late comment to the discussion. I have just done the Two-fer exercise on Python. I found it odd that there is no technical definition of what is expected. You have to look at the tests to discover how the function will be called in the no name case.

E.g. for Python it would be nice to have something like "The two_fer() function will either be called with a name passed as a string, or no arguments, and is expected to return your response as a string."
Or if it really is the intent "Have a look at the tests to see how the two_fer() function will be called."

@glennj
Copy link
Contributor

glennj commented Mar 12, 2023

That's my view of the site. The tests encode the requirements, so you need to see how the tests invoke your code to give the correct responses.

NobbZ pushed a commit to exercism/erlang that referenced this pull request Mar 13, 2023
@kytrinyx @NobbZ
Sync two-fer docs with problem-specifications
8bf1a04 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
Stargator pushed a commit to exercism/dart that referenced this pull request Mar 17, 2023
@kytrinyx @Stargator
Sync two-fer docs with problem-specifications
b45a30e 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
fapdash pushed a commit to exercism/emacs-lisp that referenced this pull request Mar 30, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#281)
3e87005 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
booniepepper pushed a commit to exercism/factor that referenced this pull request Apr 12, 2023
@kytrinyx
Sync two-fer docs with problem-specifications
6d51562 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
m-dango pushed a commit to exercism/raku that referenced this pull request Apr 28, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#597)
f59e0e1 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/red that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#84)
ad02e13 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/euphoria that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#29)
9662732 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/racket that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#251)
20b5383 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/groovy that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#340)
12171cd 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/babashka that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#72)
6f617cf 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/swift that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#604)
b5c0dd3 
* Sync bob docs with problem-specifications

The bob exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2205

* Sync two-fer docs with problem-specifications

The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/objective-c that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#299)
c5a8ba9 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/powershell that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#185)
a7e3bc2 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/scala that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#774)
8f40ef8 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/typescript that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#1304)
a006a07 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/reasonml that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#264)
3d1863a 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/haxe that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#231)
a0ff74b 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/php that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#500)
2f6d98d 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/vbnet that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#183)
88b3a64 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/d that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#187)
11c8a21 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/x86-64-assembly that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#172)
c2b81fe 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/cobol that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#90)
b581be6 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/8th that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#72)
aa0dd8d 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/wasm that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#62)
3e84f1c 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/chapel that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#69)
81b557b 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
kytrinyx added a commit to exercism/scheme that referenced this pull request May 16, 2023
@kytrinyx
Sync two-fer docs with problem-specifications (#273)
44466ee 
The two-fer exercise has been overhauled as part of a project
to make practice exercises more consistent and friendly.

For more context, please see the discussion in the forum, as well as
the pull request that updated the exercise in the problem-specifications
repository:

- https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943
- exercism/problem-specifications#2204
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iHiD iHiD iHiD approved these changes

@ee7 ee7 ee7 approved these changes

@ErikSchierboom ErikSchierboom ErikSchierboom approved these changes

@BethanyG BethanyG BethanyG approved these changes

@andrerfcsantos andrerfcsantos andrerfcsantos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Tricky Triplets - a storified replacement for Two Fer
8 participants
@kytrinyx @samtygier @glennj @ErikSchierboom @iHiD @BethanyG @andrerfcsantos @ee7