18
$\begingroup$

What should I do when editing a post, or suggesting an edit?

Math SE is a collaborative platform where almost anyone can contribute. One way in which you can improve the site is by editing posts (questions or answers) written by others. While the Help Center does provide some guidance on editing, this advice is primarily directed at users with over 2000 reputation, who are permitted to make edits without undergoing review.

The purpose of this (proposed) FAQ is to expand on that advice, and also to give some guidance to users with less than 2000 reputation, who must have their suggested edits approved by other community members.

$\endgroup$
17
$\begingroup$

When Editing

  • Consider the age of the post.

    Whenever a post is edited, it is bumped to the top of the Active Questions list on the front page. This crowds out other posts which are also deserving of attention. If a question is relatively old and already has several answers, it likely doesn't need the renewed attention—such a post should not be edited unless the edit provides a substantial improvement to the question (e.g. edits to correct a single spelling error should probably be avoided). On the other hand, smaller cosmetic edits to very new posts are more acceptable.

  • Make a noticeable improvement to the post.

    Edits should typically be used to to make significant, important improvements to a post. When you make an edit, please ensure that the changes that you are making actually make the post noticeably better. This is particularly true in the case of posts which have been closed for lacking clarity, detail, or context—if you engage in editing such a question, make sure that the final product meets the guidelines outlined in the post How to ask a good question. , and before editing a question to include additional context, please read the Guidelines for context edits and rewrites .

    Making an edit to bring a low-quality question up to site standards is particularly important in cases when the question has already been closed. The first edit made to a closed question will send that question to the Reopen Review Queue, but subsequent edits will not have this effect. Thus if the first edit doesn't improve the question so that it meets the site's quality standards, then the question is unlikely to be reopened through the Reopen Review Queue. As such, making small cosmetic changes to a closed question without fixing more substantial problems can unfairly punish the asker.

    To avoid this, make sure that edits do as much as possible to clean up or correct a post. If you edit a post to add a tag or to fix the formatting in a title, also check to see if there are other issues which need correcting: correct spelling and grammar mistakes, improve the formatting of the mathematics, remove salutations, add necessary links, and so on. When an edit is completed, the post should be up to the quality standards of the site.

  • Adhere to the original post's style.

    Edits which significantly alter the original style of a post are discouraged. For example, please do not replace \lim_{x\to a} ($\lim_{x\to a}$) with \displaystyle\lim_{x\to a} ($\displaystyle\lim_{x\to a}$) or \lim\limits_{x\to a} ($\lim_{x\to a}$) (or vice versa); don't change $\sin x$ to $\sin(x)$; don't Americanize or Britishify spellings (e.g. don't replace "color" with "colour" or vice versa); etc. Please also note that there is a general guideline on the site to avoid titles which stretch the vertical spacing. Thus the use of \displaystyle, \dfrac, \dbinom, etc is strongly discouraged.

  • Don't just remove "noise".

    Greetings, salutations, goodbyes, and expressions of thanks are generally considered to be noise, and it is entirely appropriate to remove such noise from posts while making other significant edits. However, please do not edit a post just to remove such noise. For more details on this, please refer to the meta question Deleting 'thanks for help' from posts .

  • Write a clear edit summary.

    This is particularly true for users who have not yet accrued enough reputation to make edits without approval, but is good practice for everyone. When an edit is made, there is a field for entering an edit summary, which should describe the edits being made. This helps reviewers to understand why you are editing a post, and can help draw attention to seemingly small changes. These edit summaries can also serve as guidance for the original poster, who might learn from the changes you make.

  • Limit the number of edits you make.

    This is true both in a local sense, and in a global sense.

    In a local sense, do not make many edits to a single post. As noted, every edit bumps the post to the top of the Active Questions list, and decreases the visibility of other posts. This isn't fair to the users who have posted these questions, so please try to avoid excessive editing. If a post is very complicated, you might consider using the Sandbox for drafts of long, complex posts on Meta. This can be a good place to get your thoughts clarified and the formatting worked out before making an edit (or posting a question or answer in the first place).

    In a global sense, try not to edit too many posts at once. A good rule of thumb is that you should never bump more than one or two posts to the front page at the same time. After editing one post, give it some time to fall off of the front page before editing another. Or limit yourself to only four or five edits per day.

    In both cases, the goal is to ensure that everyone has fair access to the front page.

When Suggesting an Edit

All of the above guidelines hold when suggesting an edit, only more so. While it might be acceptable for a grizzled veteran to make a small change to a very old post and leave a useless edit summary, new users who need to have their edits approved by the community should avoid this kind of editing. When you suggest an edit, you are asking other users to take some time out of their day in order to review your work. Please respect their time and suggest edits which make significant improvements, rather than minor cosmetic or quality-of-life alterations.

$\endgroup$
7
  • $\begingroup$ For the first point the "Thanks" issue might worth some particular mention. $\endgroup$ – TheSimpliFire Jan 16 at 13:50
  • $\begingroup$ @TheSimpliFire Good call. I've added a bullet point, and a link to the previous discussion. $\endgroup$ – Xander Henderson Jan 16 at 14:34
  • $\begingroup$ Are all of these facts about edit queue and front-page bumping just true for edits of others' posts, or also when you edit your own? I ask because I will sometimes review an answer I wrote a couple of weeks ago and tweak a word, or fix a spelling mistake. If these bump the post to the front page then I'll stop doing this (because I hate old questions that are front page bumped for minor edits). I know you say "written by others" at the top, but maybe repeat this in the "Limit the number .." section? I know it would clarify the issue for me. $\endgroup$ – JonathanZ supports MonicaC Jan 16 at 16:45
  • 1
    $\begingroup$ Also, I very much appreciate your making explicit the distinction between fresh posts and old posts. $\endgroup$ – JonathanZ supports MonicaC Jan 16 at 16:47
  • $\begingroup$ @JonathanZsupportsMonicaC Any time a post is edited, it jumps to the top of the front page, whether it was edited by the original poster or by someone else. For this reason, one should be a little more cautious editing old posts, even if they are the original author. On the other hand, bumping one post every month or two when you find a typo isn't a big deal, and "a couple of weeks old" is not that old. This is more about preventing new users from making, say, 100 edits to change "continuos" to "continuous" across the site over the course of three days (and yes, this has happened). $\endgroup$ – Xander Henderson Jan 16 at 19:05
  • $\begingroup$ @XanderHenderson- Thanks. I was pretty sure my activities were on the less intrusive side, but I appreciate the guidance. $\endgroup$ – JonathanZ supports MonicaC Jan 16 at 19:23
  • $\begingroup$ I think also highly relevant to both suggested edits, and edits in general, are the Guidelines for context edits and rewrites. $\endgroup$ – amWhy Jan 16 at 22:40

You must log in to answer this question.

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