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

print_display: Comment at end indicates an error, yet example compiles and runs without error. #1870

Open
systemdlete opened this issue Aug 8, 2024 · 0 comments

Comments

@systemdlete
Copy link

systemdlete commented Aug 8, 2024

As a learner, I was confused by the way this comment was written. Certainly, the absence of the binary method (trait?) will cause an error, but the example does not actually attempt to do so (for an obvious reason).

When I read "Error." I thought, ok, there is an error. But where? Reading further on, this is revealed, of course, for the particular choice (why that particular one?) of demonstrating the absence of the binary implementation. Maybe rewording this section would be helpful. In particular, maybe leave out the sentence fragment ("Error.").

"This will not work" should probably be preceded by a line break, and reworded to "The following will not work:" or something like that. It seems all run-together as it stands.

I am sure that if I come back to this example in the future, I might grin at how "obvious" this all seems. But at this early point in my own learning, it throws me off a bit. (Case in point; After just a few days, coming back to it and reviewing it for the purposes of posting this issue, it already makes more sense to me.)

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

1 participant