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

Question about newline intentions and potential formatting improvements #2552

Closed
codingthat opened this issue Apr 3, 2025 · 2 comments
Closed

Comments

@codingthat
Copy link

I noticed that certain files, e.g. https://github.com/exercism/problem-specifications/blob/main/exercises/resistor-color-duo/description.md?plain=1, have parts that go beyond the sentence per line rule:

From the example above:
brown-green should return 15, and
brown-green-violet should return 15 too, ignoring the third color.

Should there be extra newlines in cases like this, to render this effect to the reader?

Alternatively, would parts like this (and the bullet list before it) actually be better as tables?

Just trying to get a feel for how to make improvements or if this is already how it's intended to be. Thanks! :)

Copy link
Contributor

github-actions bot commented Apr 3, 2025

Hello. Thanks for opening an issue on Exercism 🙂

At Exercism we use our Community Forum, not GitHub issues, as the primary place for discussion. That allows maintainers and contributors from across Exercism's ecosystem to discuss your problems/ideas/suggestions without them having to subscribe to hundreds of repositories.

This issue will be automatically closed. Please use this link&category=support ) to copy your GitHub Issue into a new topic on the forum, where we look forward to chatting with you!

If you're interested in learning more about this auto-responder, please read this blog post.

@github-actions github-actions bot closed this as completed Apr 3, 2025
@kotp
Copy link
Member

kotp commented Apr 3, 2025

The newline after and should be removed in that case, as it is not a sentence break there.

But it appears as though the intention of communication there is to bring to attention the information, and a bullet list here could be helpful, providing the "side by side" view that is provided there with the split where it is. That is what it seems like the formatting is attempting to provide by having that line break there.

This happens if reading it in plain text but does not survive the rendering in this way. A bullet list would provide what seems to be intended, by my calculation.

That said, this conversation should be happening on the forum, rather than here, really.

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

No branches or pull requests

2 participants