Edit - Meta 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

I'm not really sure what you're advocating with this answer. Personally I disagree when I see explanation of what the code does hidden as inline comments (both on SO and in real life).

hayd
– hayd

2013-09-16 22:20:10 +00:00
Commented Sep 16, 2013 at 22:20
@hayd I'm advocating the we need to decide what balance needs to be there between code and comments - this is what underlies Boltcock's question, does it not ? (I'm not taking a stance re code vs. comment, other than that more comments is usually better than less.) Does that make sense ?

Howard Pautz
– Howard Pautz

2013-09-17 00:09:34 +00:00
Commented Sep 17, 2013 at 0:09

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 »