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

Revise use of "foo" and "bar" #1

Open
daobrien opened this issue May 15, 2017 · 2 comments
Open

Revise use of "foo" and "bar" #1

daobrien opened this issue May 15, 2017 · 2 comments
Assignees

Comments

@daobrien
Copy link
Contributor

We encourage (read "demand") that writers not use these terms in RH docs, so we should do the same.

Yes, it's common, understood, it's rare that ppl would take offence, but leading by example is a good idea.

@notklaatu
Copy link
Collaborator

What's the proposed alternative?
Example1 and Example2, maybe?

I find that using actual commands or applications becomes very distracting. People miss the grammatical stuff and start debating whether a sentence is actually true or not.

Example:

The `rm` command is destructive, and it should never be used.

Instead of talking about whether that comma is good or bad, students debate over the value of the rm command.

@daobrien
Copy link
Contributor Author

Yes, or "myApp1" and "myApp2"?
Just use something that's obviously bogus, while still avoiding the foobar/fubar issue that was raised elsewhere.
Is the second part of your question related, or did that come from elsewhere? I agree with your conclusion, and I think that's what happens in some of the quizzes.

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