-
-
Notifications
You must be signed in to change notification settings - Fork 214
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
docs: small fixes for doctor-data instructions #749
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you guys really want this I'll approve.
But I like the previous version more. The "elements" of an enum
are called enumerators, enum
is the type itself.
@siebenschlaefer
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? |
Needs one more substitution: #742 |
Here is a more complete excerpt:
The second sentence seems to refer to the type itself. That's why I suggested using |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@siebenschlaefer After a careful reading of your comments and the provided link, I believe that the following terms should be used
enumeration
: refers to the type (in this case,System
)enumerator
: refers to an enum variant (in this case,BetaHydri
)
I would therefore propose the following rephrasing, which more closely matches the standard (emphasis mine):
The third argument comes from a
star_map
namespace.
It is an enumeration type namedSystem
.
You even got one of the enumerators:BetaHydri
.
As an aside, I didn't know that the term enumerator was used in the C++ standard to refer to an enum variant. Because of that, I thought using enumerator was misleading to people coming from other languages. I do in fact like to use proper C++ terminology when possible. 🙂
Also add clarification to the garbled data: https://forum.exercism.org/t/corruption-in-the-c-track-repo/9088/6 |
[no important files changed]
Suggestions by @clechasseur