6
\$\begingroup\$

I have a feeling that our guidances should be worded better. Take this excerpt from the Help Center:

To the best of my knowledge, does the code work?

I believe this question is incorrect, as seen by https://codereview.stackexchange.com/questions/75043/c-youtube-downloader-error and there are most likely more questions around.

We should be asking people if, to the best of their knowledge, they think that their program works, not their code. We can see cases where people post code here that does compile and does not throw exceptions during runtime, yet does not do what is intended. So they conclude that their code works, but their program does not. We, as a general consensus, however require that their program works.


Hence my suggestion is to replace all occurrences of "does the code work" to "does the program work", wherever it makes sense. The obvious replacement would be in the Help Center in the excerpt listed above, perhaps there are more places where it should be changed.

This will not get rid of off-topic questions from users that do not read anything, but it will discourage users who know what they are doing and truly believe posting here is correct, because their code works in spite of their program not working.

\$\endgroup\$
1
  • 4
    \$\begingroup\$ I've added "… as intended" to the help center. \$\endgroup\$
    – 200_success Mod
    Commented Dec 30, 2014 at 23:15

1 Answer 1

16
\$\begingroup\$

This site being Code Review, we require working code. We review excerpts of code that aren't complete programs. They could be library functions or even just a line or two of code.

Let's not change our wording from "code" to "program" just because some users have an excessively liberal concept of what "working" means.

\$\endgroup\$
4
  • \$\begingroup\$ "the code is working, it just doesn't do what I want that it does!", is that a very liberal concept? \$\endgroup\$
    – skiwi
    Commented Dec 28, 2014 at 18:47
  • 11
    \$\begingroup\$ I'd be OK with adding "To the best of my knowledge, does the code work as intended?" \$\endgroup\$
    – 200_success Mod
    Commented Dec 28, 2014 at 18:51
  • 5
    \$\begingroup\$ +1 for "works as intended". \$\endgroup\$
    – rolfl Mod
    Commented Dec 28, 2014 at 22:03
  • \$\begingroup\$ Yes yes. Works as intended. \$\endgroup\$
    – RubberDuck
    Commented Dec 28, 2014 at 22:23

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .