Skip to content

Conversation

@hunkyjimpjorps
Copy link
Contributor

being more explicit that "it" in this case is the function

being more explicit that "it" in this case is the function
@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2023

Hello. Thanks for opening a PR on Exercism. We are currently in a phase of our journey where we have paused community contributions to allow us to take a breather and redesign our community model. You can learn more in this blog post. As such, all issues and PRs in this repository are being automatically closed.

That doesn't mean we're not interested in your ideas, or that if you're stuck on something we don't want to help. The best place to discuss things is with our community on the Exercism Community Forum. You can use this link to copy this into a new topic there.


Note: If this PR has been pre-approved, please link back to this PR on the forum thread and a maintainer or staff member will reopen it.

@github-actions github-actions bot closed this Apr 1, 2023
@BNAndras BNAndras reopened this Nov 1, 2023
@BNAndras
Copy link
Member

BNAndras commented Nov 2, 2023

Thanks for the PR. I'd be glad to accept it, but the instructions.md for that exercise comes from https://github.com/exercism/problem-specifications/blob/main/exercises/hello-world/description.md. That repo contains the shared metadata and documentation for all practice exercises on Exercism. If we make the edit here, it'll be overwritten the next time I sync the documentation from that repo. Therefore, I'd suggest making this PR in the problem-specifications repo instead. Then, all of Exercism's tracks can benefit from this potential change and it won't be overwritten by later syncs.

@BNAndras BNAndras closed this Nov 2, 2023
@BNAndras BNAndras added the x:type/docs Work on Documentation label Nov 2, 2023
@hunkyjimpjorps
Copy link
Contributor Author

hunkyjimpjorps commented Nov 3, 2023

The impetus for making this change was me showing Exercism to someone else in the Racket community, and them getting mad at the description for being misleading because they thought the correct answer would be something like (println "Hello World") based on a restrictive reading of "it". I think I thought about that when I originally proposed that, but I decided to target it specifically to the track because I'm not familiar enough with all the other tracks to know if "the function" is the proper way to describe what's going on in all of them (for example, it might be a class method in Java, or a word in Forth, etc.).

@hunkyjimpjorps hunkyjimpjorps deleted the patch-1 branch November 3, 2023 19:27
@BNAndras
Copy link
Member

BNAndras commented Nov 3, 2023

Yeah, it’s been a fairly common issue for students even with the recently added Hello World video. I think that PR will be well-received.

If they pass, I think it’s worth adding an instructions append section here which comes after the standard set of instructions. There, we can clarify it’s a function returning a value.
Another option I’m considering is that I recall the Python test runner having code specifically for testing hello-world that gives more specific error information about what’s expected. We could do something similarly here with the caveat it only helps students working online with our test runner.

@BNAndras
Copy link
Member

@hunkyjimpjorps, would you be okay submitting a PR for an instructions append file for this exercise? See https://exercism.org/docs/building/tracks/practice-exercises#h-documentation-files. This would be specific to just Racket so you can clarify the "it" as a function. If you need an idea of what they look like, the Python track has several examples of instructions appends.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

x:type/docs Work on Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants