Skip to content
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

Exercise asks developer to write a function #2396

Open
10 tasks
kotp opened this issue Feb 25, 2024 · 10 comments
Open
10 tasks

Exercise asks developer to write a function #2396

kotp opened this issue Feb 25, 2024 · 10 comments
Labels
documentation x:knowledge/elementary Little Exercism knowledge required x:type/docs Work on Documentation

Comments

@kotp
Copy link
Member

kotp commented Feb 25, 2024

Having an exercise direct a student to write a function or write a
method or write "some specific structure" can be confusing when the
language they are solving the exercise in does not have that structure.

Where we say things like "Create a function" or "Write a function" we
could be indicating that we need a solution instead. This will
encourage the student to determine what that solution is,
rather than us telling them to specifically create a function.

Unless the exercise is a concept exercise about functions, of course,
then the student should be told to create a function.

The exercises that mention "create a function" are:

  • exercises/parallel-letter-frequency/description.md

And the exercises that mention "Write a function" are:

  • exercises/sublist/metadata.toml
  • exercises/flatten-array/description.md
  • exercises/nucleotide-codons/metadata.toml
  • exercises/nucleotide-codons/description.md
  • exercises/alphametics/metadata.toml
  • exercises/alphametics/description.md
  • exercises/go-counting/description.md
  • exercises/darts/description.md
  • exercises/darts/metadata.toml

ref: exercism/ruby#1638-comment

@kotp kotp added documentation x:knowledge/elementary Little Exercism knowledge required x:type/docs Work on Documentation labels Feb 25, 2024
@glaxxie
Copy link
Contributor

glaxxie commented Mar 3, 2024

I accidentally clicked on the checkbox, I apologize if it triggers anything.

@BNAndras BNAndras closed this as completed Mar 3, 2024
@BNAndras BNAndras reopened this Mar 3, 2024
@BNAndras
Copy link
Member

BNAndras commented Mar 3, 2024

Sigh. I didn’t mean to close the issue. Stupid thumbs on a small screen.

@jiegillet
Copy link
Contributor

Has this been linked to students actually being confused?
The semantic difference seems so small to me, I wouldn't want to spend time and energy on a non-issue.

@kotp
Copy link
Member Author

kotp commented Mar 4, 2024

Has this been linked to students actually being confused? The semantic difference seems so small to me, I wouldn't want to spend time and energy on a non-issue.

Yes, I can see how the meaning shift can be small for someone that is used to hearing it misused as often as I can imagine someone with your experience as having. We learn to "you mean this, but said that, I will not mention the difference in meaning" and we can definitely function like that. That is not really kind, but it is something that happens fairly often. They will continue to say things that they really do not mean to say, and it will likely not cause a problem.

But when someone is looking at how to make a function in a language that does not have them, how do they find what they can not find? They have to, a bit clumsily, choose to ignore the meaning of the word and find the closest thing they can to do what was asked of them.

Semantics are all we have at the end of the day, the meaning of words. So even small differences make a big difference, especially when it is something that is at the very core of certain languages, and non-existent in others.

@jiegillet
Copy link
Contributor

In general, I agree with you, but has this specific case been linked to students actually being confused?

@kotp
Copy link
Member Author

kotp commented Mar 4, 2024

In general, I agree with you, but has this specific case been linked to students actually being confused?

This specific case? I listed 10, and that covers 65 languages, some of which do not have functions, so I am just as confused this second time reading that as I was the first time it was asked.

So no, this is not a specific case being brought up.

@MatthijsBlom
Copy link
Contributor

has this specific case been linked to students actually being confused?

This forum thread looks like an instance: Is a string value in Haskell a function? I vaguely remember this having come up other times as well. Also, there once was #1850.

adamazing added a commit to adamazing/exercism-problem-specifications that referenced this issue Mar 19, 2024
Signed-off-by: Adam Henley <adamazing@gmail.com>
kotp pushed a commit that referenced this issue Mar 28, 2024
* Exercises no longer ask developers to 'write a function' (#2396)
* Change requests from review (avoiding `return` and using more specific language)
* Update missed metadata instances, missed return, and bravely fix the nucleotide-codons description
* Remediate `Write some code` in alphametics exercise description
---------

Signed-off-by: Adam Henley <adamazing@gmail.com>
@DazSanchez
Copy link

@kotp Could you update the status of this issue to Close if the related PR addresses the original problem?

@IsaacG IsaacG closed this as completed Apr 1, 2024
@kotp
Copy link
Member Author

kotp commented Apr 2, 2024

@kotp Could you update the status of this issue to Close if the related PR addresses the original problem?

I could, but there are still more to address. Some of them have been. (Not sure why none of them are checked off from the checkboxes, though, I think that is not reserved just for me to do).

But if Isaac is happy to close this issue that is fine, as that does not mean that we can not address the rest of them that are still pending.

Definitely an improvement though! Thank you for the work and improvements!

@IsaacG
Copy link
Member

IsaacG commented Apr 2, 2024

My bad. I thought we got them all. From a quick glance over the grep output, the sublist looks like it might be the only remaining exercise with obvious room for rewriting.

@IsaacG IsaacG reopened this Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation x:knowledge/elementary Little Exercism knowledge required x:type/docs Work on Documentation
Projects
None yet
Development

No branches or pull requests

7 participants