4

I recently submitted this edit suggestion:

https://stackoverflow.com/review/suggested-edits/36801118

It seemed to me to be pretty straightforward. As the name of a system file, /etc/sysctl.conf should have had inline backtick formatting, and there were also grammar fixes to be made. So:

Just append following line to /etc/sysctl.conf file:

became

Just append the following line to your /etc/sysctl.conf file:

However, it's been rejected by two reviewers with:

The edit does not improve the quality of the post. Changes to the content are unnecessary or make the post more confusing.

I honestly do not agree that it doesn't improve the quality of the post. Even if someone takes issue with the grammar fixes, I still believe that the inline formatting for the file name should have been applied (and that if anyone with enough rep for a 2-character edit is reading this, I really think that adding the necessary backticks would improve that post.)

I also checked the reviewer stats, and noticed that one of the reviewers had no track record of any accepts/rejects/other review activity apart from the single vote to reject my edit, which I have to say seems a little odd.

4
  • 3
    The user with no activity is the post author. The post author has the ability to review suggested edits on their own post. Commented Apr 3 at 17:49
  • 5
    I don't think the filename is code. No need for code formatting to it. Commented Apr 3 at 17:49
  • 3
    @VLAZ It doesn't actually need to be code. I'd like to refer you to meta.stackexchange.com/a/215595/449737, in which it is said that the inline formatting should be applied to "Any string that can be recognized or generated by a computer", and the examples of such strings include "(the name of) a ... file, file path, file extension". Commented Apr 3 at 17:59
  • 4
    Plow forward, my friend. You are almost the point, 2000 rep, where you no longer need a review to make an edit. That said, I'd have bolded or italicized rather than code-formatted. Commented Apr 3 at 20:29

2 Answers 2

9

If applying inline code formatting to a file name were the only change your edit was making, then I'd have to agree with it being rejected as being, effectively, "too minor". That is to say, not a substantive improvement to the quality or readability of the post—an unnecessary edit that wastes not only your time, but the time of all the reviewers.

You note in a comment replying to VLAZ that there is an answer on Meta Stack Exchange that says it is permissible to format "Any string that can be recognized or generated by a computer", including the name of "file, file path, file extension". This is certainly true; it is permissible. But it is not obligatory. If the post is easily readable without this change, then the change is not needed. A single, short file name/path is easily readable without the need for any code formatting. And, there's a strong argument to be made that overuse of code formatting makes posts vastly less readable. (In this case, it's hard to argue that a single thing formatted as inline code makes the post less readable, but, at the same time, it's equally hard to argue that having that single thing formatted as inline code makes the post more readable. So you see why I would consider it effectively pointless?)

For what it's worth, the canonical reference for when one should use inline code formatting on Stack Overflow is here on Meta Stack Overflow. What you find here on Meta Stack Overflow is generally going to be more accurate guidance when it comes to what is encouraged behavior on Stack Overflow. But that's not disagreeing with the other answer, because it does say that file names/paths can be formatted as inline code.

There's also this FAQ on how to make a good edit here on MSO, and it's worth noting that the answer specifically calls out guidelines and cautions for use (and overuse) of inline code formatting.

So, I've established that I would agree with the rejection of your edit if its only change were adding inline code formatting to that file name/path. But that wasn't the only thing your edit did; it also made improvements to the grammar. These, I would argue, substantively improved the readability of the post. On that basis, I've exercised moderator privileges to force through the approval of that edit.

I would add one lesson for the future: When you're making edits, try to fix all of the problems with the post. In this case, it was a short post, so it doesn't seem like there were any other problems. But there was one minor one: a code block (its own paragraph/section) that was formatted as inline code. That should have been converted to block code formatting. I've also gone ahead and made that minor change.

4

Yeah, it's a long-standing tension: edits that are too trivial are discouraged, but we do want to encourage edits that improve the post. So where is the boundary line for what counts as "too trivial"? It's subjective.

I would have approved this suggested edit, but I can also understand why others might reject it. The revision fixed a grammatical mistake, but I don't think it was necessary, so I think one could make an argument either way.

Here are some references:

Any time you see a post that needs improvement and are inclined to edit it, you are encouraged to do so.

Some common reasons to edit a post are: [...] To fix grammatical or spelling mistakes [...]

Tiny, trivial edits are discouraged; try to make the post significantly better when you edit, correcting all problems that you observe.

https://stackoverflow.com/help/privileges/edit

Also:

Approve if the edit improves the post [...]

Reject if the edit is unnecessary [...]

Common reasons to Approve [...] Improves grammar, spelling, or formatting of the post [...]

Common reasons to Reject [...] changes to content or formatting that are unnecessary [...] changes to grammar, spelling, or style that are unnecessary

https://stackoverflow.com/help/review-suggested-edits

How does your edit fare according to those criteria? Arguably, your edit improves the post by improving grammar and formatting. On the other hand, there is also a reasonable argument that the post didn't need improvement and your edit is a "tiny, trivial edit" that isn't necessary. It's a judgement call, and I can see different reviewers disagreeing on this point.

Why do we have these guidelines? On the one hand, we want to build an archive of knowledge and improve it and make it more useful for others. On the other hand, we have some limits on our capacity to review suggested edits: it takes time from volunteers, and we have a limited number of volunteers willing to review suggested edits, so we ask that people focus on edits that make a substantive improvement (until you have enough reputation to edit without needing review from others).

Related: "Too minor" edits - better to leave poor quality on the site?, What do I now do for a previously "too minor" edit?, Are trivial edits okay if I have full editing privileges?, Do the instructions for the edit review queue need to be improved?

1
  • 1
    I just don't agree with your characterization of rejections at all... I read the edit in question as a clean-cut grammar correction, albeit alongside a more subjective style change (which, to be fair, I do agree with). The bar for edit approval in the help center isn't "is it necessary 'enough' to approve", it's "did it clearly improve the post"– that's the only material criteria it needs to meet. "Unnecessary" is secondary, it's for edits which don't obviously qualify as "improvement"... as this edit corrected objectively wrong grammar, I don't see a defensible argument for rejection. Commented Apr 3 at 23:31

You must log in to answer this question.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.