search

exercism / cpp

Exercism exercises in C++.
https://exercism.org/tracks/cpp
MIT License
252 stars 205 forks source link

docs: small fixes for doctor-data instructions #749

Closed vaeng closed 6 months ago

vaeng commented 8 months ago

Suggestions by @clechasseur

vaeng commented 8 months ago

@siebenschlaefer Here is @clechasseur original reasoning:

In the first task, the text mentions an "enumerator of type System". I think the use of the term "enum" (or perhaps "enumeration") would be better, because "enumerator" is used in many languages to mean something quite different from a C++ enum.

I might go the middle way by inserting a short "reminder" about the naming convention of enums in C++ and reverting it to the original state. What do you think?

vaeng commented 8 months ago

Needs one more substitution: https://github.com/exercism/cpp/issues/742

clechasseur commented 8 months ago

Here is a more complete excerpt:

The third argument comes from a `star_map` namespace.
It is an enumerator of type `System`.
You even got one of the enumerations: `BetaHydri`.

The second sentence seems to refer to the type itself. That's why I suggested using enum instead of enumerator.

siebenschlaefer commented 8 months ago

I don't object to this change. I understand that these concepts don't target language lawyers and that it might sense to use terms that are easier to understand than what is used in the standard. I just wanted to give the C++ perspective where "enumerator" is the correct term (see [dcl.enum] in the current draft of the standard.

vaeng commented 6 months ago

Also add clarification to the garbled data: https://forum.exercism.org/t/corruption-in-the-c-track-repo/9088/6