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.

Required fields*

Rev

2

+1 to not removing the comments if they are necessary to understanding the code.

sevenseacat
– sevenseacat

2014-01-06 08:10:21 +00:00
Commented Jan 6, 2014 at 8:10
Thank you for your answer. I can see merits to this approach in certain situations too. As I followed-up to sleske's answer, I suppose there's no way to retain private comments without creating a new branch if I use the rebase -i method?

Gerhard
– Gerhard

2014-01-09 04:48:10 +00:00
Commented Jan 9, 2014 at 4:48
4

If you need comments to write the code, then clearly I need the comments to be able to maintain the code.

gnasher729
– gnasher729

2017-07-11 08:52:40 +00:00
Commented Jul 11, 2017 at 8:52

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 »