Edit - Software Engineering Stack Exchange

You are not logged in. Your edit will be placed in a queue until it is peer reviewed.

We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.

2

Citing bug IDs in patch notes is just.. very unfriendly.

Andreas Bonini
– Andreas Bonini

2012-03-28 18:49:19 +00:00
Commented Mar 28, 2012 at 18:49
3

@krelp It is helpful when you are working with a vendor to get an issue fixed and you can track the bug ID you received with a bug id in the release notes.

Darryl Braaten
– Darryl Braaten

2012-03-28 20:00:35 +00:00
Commented Mar 28, 2012 at 20:00
1

@Krelp I wondered why that's a bad idea, so I asked here: programmers.stackexchange.com/questions/142258/… Perhaps you have some input on that? :)

Travis Northcutt
– Travis Northcutt

2012-03-30 14:35:10 +00:00
Commented Mar 30, 2012 at 14:35

Add a comment |

Correct minor typos or mistakes
Clarify meaning without changing it
Add related resources or links
Always respect the author’s intent
Don’t use edits to reply to the author

create code fences with backticks ` or tildes ~
```
like so
```
add language identifier to highlight code
```python
def function(foo):
print(foo)
```
put returns between paragraphs
for linebreak add 2 spaces at end
_italic_ or **bold**
indent code by 4 spaces
backtick escapes `like _so_`
quote by placing > at start of line
to make links (use https whenever possible)

<https://example.com>

[example](https://example.com)

<a href="https://example.com">example</a>

formatting help »
answering help »