Skip to content

Rework largest-series-product documentation - #2246

Merged
kytrinyx merged 3 commits into
mainfrom
largest-series-product-rewrite
Apr 6, 2023
Merged

kytrinyx merged 3 commits into
mainfrom
largest-series-product-rewrite

Conversation

@kytrinyx

@kytrinyx kytrinyx commented Mar 31, 2023 •

Copy link
Copy Markdown
Member

This exercise is one of the focus exercises for 12in23.

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 aim to merge this PR in roughly 72 hours, and then submit PRs to all tracks that have this exercise.

The main change is to frame the exercise within the context of a story.

NOTE: I removed the bit about the empty product. Talking to Jeremy we concluded that we could simplify the description of this exercise immensely if we remove the one test case for the empty product, and we decided that this is a trade-off that we want to make.

Once this PR is merged, and the downstream PR to all the tracks is submitted, I will go through all those PRs and manually deprecate the test in question in the tests.toml, as well as deleting the test case from the test suite.

This PR is part of our project of making our Practice Exercises
more consistent and human. For more context please see the
following forum-thread:
https://forum.exercism.org/t/new-project-making-practice-exercises-more-consistent-and-human-across-exercism/3943

The main change is to frame the exercise within the context of story.
@kytrinyx
kytrinyx requested a review from a team as a code owner March 31, 2023 14:12
Comment thread exercises/largest-series-product/instructions.md Outdated
Comment thread exercises/largest-series-product/instructions.md Outdated
kytrinyx and others added 2 commits March 31, 2023 22:30
@kytrinyx

kytrinyx commented Apr 6, 2023

Copy link
Copy Markdown
Member Author

@BethanyG I saw that there's a discussion about the Python version of this exercise in the forum:
https://forum.exercism.org/t/seeming-discrepancy-between-instructions-and-tests-in-largest-series-product/5050/2

We're planning on removing the test with the zero span, in order to simplify the instructions (removing the entire section about what an empty product means and what the value of it is, and why). If I go ahead and merge this, and sync to the Python track and remove the empty span test, does that seem like it would solve the issue discussed in the forum? Or has the Python exercise diverged a bit from the core spec?

@BethanyG

BethanyG commented Apr 6, 2023

Copy link
Copy Markdown
Member

@kytrinyx -- I think removing the tests altogether would fix the problem, yes.

The discussion on the forum was in regards to this Python addendum that got super-specific with the error messages, since the Python tests were changed to check for the exact phrasing from problem specs. But then the phrasing got changed and the addendum became out of sync. 🤦🏽‍♀️

Removing the need to check altogether will allow us to omit those messages in the addendum. 😄

@kytrinyx

kytrinyx commented Apr 6, 2023

Copy link
Copy Markdown
Member Author

Cool! In that case I will merge this now, and then work on updating the tracks over the next week or so.

@kytrinyx
kytrinyx merged commit f9ba5b6 into main Apr 6, 2023
@kytrinyx
kytrinyx deleted the largest-series-product-rewrite branch April 6, 2023 19:54
kytrinyx added a commit to exercism/ruby that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kytrinyx added a commit to exercism/ceylon that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kytrinyx added a commit to exercism/vimscript that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kytrinyx added a commit to exercism/perl5 that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kytrinyx added a commit to exercism/go that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kytrinyx added a commit to exercism/nim that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kytrinyx added a commit to exercism/cfml that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kytrinyx added a commit to exercism/gleam that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kytrinyx added a commit to exercism/babashka that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
ceddlyburge pushed a commit to exercism/elm that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
ryanplusplus pushed a commit to exercism/lua that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
jonmcalder pushed a commit to exercism/r that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
ErikSchierboom pushed a commit to exercism/csharp that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
ErikSchierboom pushed a commit to exercism/fsharp that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
NobbZ pushed a commit to exercism/erlang that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
ryanplusplus added a commit to exercism/c that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.

* Fixed tests

---------

Co-authored-by: Ryan Hartlage <ryanplusplus@gmail.com>
vaeng pushed a commit to exercism/cpp that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kotp pushed a commit to exercism/ruby that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
kotp pushed a commit to exercism/perl5 that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
IsaacG pushed a commit to exercism/bash that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
IsaacG pushed a commit to exercism/awk that referenced this pull request Apr 12, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
BethanyG pushed a commit to exercism/python that referenced this pull request Apr 12, 2023
The largest-series-product 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#2246
lpil pushed a commit to exercism/gleam that referenced this pull request Apr 13, 2023
The largest-series-product 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#2246
meatball133 pushed a commit to exercism/crystal that referenced this pull request Apr 15, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kotp pushed a commit to exercism/vimscript that referenced this pull request Apr 18, 2023
The largest-series-product 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#2246
meatball133 pushed a commit to meatball133/crystal that referenced this pull request May 3, 2023
…m#395)

* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/java that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/kotlin that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/babashka that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/swift that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/scala that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/objective-c that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/typescript that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/ceylon that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/haskell that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/lfe that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
kytrinyx added a commit to exercism/php that referenced this pull request May 16, 2023
* Sync largest-series-product docs with problem-specifications

The largest-series-product 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#2246

* Delete test cases from largest-series-product

This deletes two deprecated test cases so that we can
dramatically simplify the instructions for this exercise.
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.

4 participants