Skip to main content
Code Review

Return to Answer

replaced http://codereview.stackexchange.com/ with https://codereview.stackexchange.com/
Source Link
Community Bot
Community Bot
  • 5

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

There are others I could go more in-depth withThere are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

Here is what I imagine as being a more "full" example of what the Help Center defines as off-topic:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

Best-practices questions that include code have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

  • Using a for-loop instead of sleeping?

    For this question, we can see a that it abides by all of the the requirements in the tag wiki. It contains a short snippet of code (there were arguments that one line was too short, we didn't define what short is in the tag wiki); it questions the general interest of delaying code execution for a specific interval; and it does contain a real excerpt of code from one of the OP's programs, with plenty of context what the line of code is being used for.

  • 'do { statement; } while(0)' against 'statement' when writing C macro?

    Here the question provides two different cases that are being used simultaneously in a project, and asks for the better of the two options. They provide the context of usage, the short snippet of code to be reviewed, and it is a common enough issue that it is a general interest to readers.

There are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

Here is what I imagine as being a more "full" example of what the Help Center defines as off-topic:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

Best-practices questions that include code have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

  • Using a for-loop instead of sleeping?

    For this question, we can see a that it abides by all of the the requirements in the tag wiki. It contains a short snippet of code (there were arguments that one line was too short, we didn't define what short is in the tag wiki); it questions the general interest of delaying code execution for a specific interval; and it does contain a real excerpt of code from one of the OP's programs, with plenty of context what the line of code is being used for.

  • 'do { statement; } while(0)' against 'statement' when writing C macro?

    Here the question provides two different cases that are being used simultaneously in a project, and asks for the better of the two options. They provide the context of usage, the short snippet of code to be reviewed, and it is a common enough issue that it is a general interest to readers.

There are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

Here is what I imagine as being a more "full" example of what the Help Center defines as off-topic:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

Best-practices questions that include code have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

Clarified "These kinds of questions" in the conclusion
Source Link
200_success
200_success
  • 145.7k
  • 4
  • 114
  • 284

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

  • Using a for-loop instead of sleeping?

    For this question, we can see a that it abides by all of the the requirements in the tag wiki. It contains a short snippet of code (there were arguments that one line was too short, we didn't define what short is in the tag wiki); it questions the general interest of delaying code execution for a specific interval; and it does contain a real excerpt of code from one of the OP's programs, with plenty of context what the line of code is being used for.

  • 'do { statement; } while(0)' against 'statement' when writing C macro?

    Here the question provides two different cases that are being used simultaneously in a project, and asks for the better of the two options. They provide the context of usage, the short snippet of code to be reviewed, and it is a common enough issue that it is a general interest to readers.

There are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

Here is what I imagine as being a more "full" example of what the Help Center defines as off-topic:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

These types ofBest-practices questions that include code have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

  • Using a for-loop instead of sleeping?

    For this question, we can see a that it abides by all of the the requirements in the tag wiki. It contains a short snippet of code (there were arguments that one line was too short, we didn't define what short is in the tag wiki); it questions the general interest of delaying code execution for a specific interval; and it does contain a real excerpt of code from one of the OP's programs, with plenty of context what the line of code is being used for.

  • 'do { statement; } while(0)' against 'statement' when writing C macro?

    Here the question provides two different cases that are being used simultaneously in a project, and asks for the better of the two options. They provide the context of usage, the short snippet of code to be reviewed, and it is a common enough issue that it is a general interest to readers.

There are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

Here is what I imagine as being a more "full" example of what the Help Center defines as off-topic:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

These types of questions have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

  • Using a for-loop instead of sleeping?

    For this question, we can see a that it abides by all of the the requirements in the tag wiki. It contains a short snippet of code (there were arguments that one line was too short, we didn't define what short is in the tag wiki); it questions the general interest of delaying code execution for a specific interval; and it does contain a real excerpt of code from one of the OP's programs, with plenty of context what the line of code is being used for.

  • 'do { statement; } while(0)' against 'statement' when writing C macro?

    Here the question provides two different cases that are being used simultaneously in a project, and asks for the better of the two options. They provide the context of usage, the short snippet of code to be reviewed, and it is a common enough issue that it is a general interest to readers.

There are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

Here is what I imagine as being a more "full" example of what the Help Center defines as off-topic:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

Best-practices questions that include code have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

deleted 56 characters in body
Source Link
syb0rg
syb0rg
  • 21.9k
  • 17
  • 24

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

  • Using a for-loop instead of sleeping?

    For this question, we can see a that it abides by all of the the requirements in the tag wiki. It contains a short snippet of code (there were arguments that one line was too short, we didn't define what short is in the tag wiki); it questions the general interest of delaying code execution for a specific interval; and it does contain a real excerpt of code from one of the OP's programs, with plenty of context what the line of code is being used for.

  • 'do { statement; } while(0)' against 'statement' when writing C macro?

    Here the question provides two different cases that are being used simultaneously in a project, and asks for the better of the two options. They provide the context of usage, the short snippet of code to be reviewed, and it is a common enough issue that it is a general interest to readers.

There are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

AnHere is what I imagine as being a more "full" example of what the Help Center defines as off-topic is "What is the best practice regarding X?" Here is what I imagine as being a more "full" example:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

These types of questions have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

  • Using a for-loop instead of sleeping?

    For this question, we can see a that it abides by all of the the requirements in the tag wiki. It contains a short snippet of code (there were arguments that one line was too short, we didn't define what short is in the tag wiki); it questions the general interest of delaying code execution for a specific interval; and it does contain a real excerpt of code from one of the OP's programs, with plenty of context what the line of code is being used for.

  • 'do { statement; } while(0)' against 'statement' when writing C macro?

    Here the question provides two different cases that are being used simultaneously in a project, and asks for the better of the two options. They provide the context of usage, the short snippet of code to be reviewed, and it is a common enough issue that it is a general interest to readers.

There are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

An example of what the Help Center defines as off-topic is "What is the best practice regarding X?" Here is what I imagine as being a more "full" example:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

These types of questions have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

I agree that this is a bad rule.

First, I reference the wiki for (emphasis of mine).

Best-practice questions generally involve a short excerpt of code with a question of general interest, usually focused more on maintainability concerns than the algorithm to solve the task at hand. Note that questions must include a real code excerpt and sufficient context for reviewers to make specific recommendations relevant to your situation; hypothetical questions are off-topic for Code Review.

Now we can look at a couple of questions with regard to . All of these are currently closed as of this question's posting.

  • Using a for-loop instead of sleeping?

    For this question, we can see a that it abides by all of the the requirements in the tag wiki. It contains a short snippet of code (there were arguments that one line was too short, we didn't define what short is in the tag wiki); it questions the general interest of delaying code execution for a specific interval; and it does contain a real excerpt of code from one of the OP's programs, with plenty of context what the line of code is being used for.

  • 'do { statement; } while(0)' against 'statement' when writing C macro?

    Here the question provides two different cases that are being used simultaneously in a project, and asks for the better of the two options. They provide the context of usage, the short snippet of code to be reviewed, and it is a common enough issue that it is a general interest to readers.

There are others I could go more in-depth with, but I think you get the point.

Why I think this rule exists in the Help Center:

Here is what I imagine as being a more "full" example of what the Help Center defines as off-topic:

What is the best practice regarding X?

I am trying to implement X into my code, and I am wondering what the best practices for this are? Any suggestions?

In my fuller example, no code is actually being reviewed, because none is being supplied. It doesn't include the OP's implementation, may or may not be of general interest, and doesn't provide any context to the reviewers. This is a question that I would consider as off-topic.

Conclusion:

These types of questions have been historically successful and popular, and will be beneficial to have in the future for this site. Either edit the tag to avoid confusion regarding things that are on or off-topic with this site, or clarify the phrasing in the Help Center.

Source Link
syb0rg
syb0rg
  • 21.9k
  • 17
  • 24