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.

Then with Literate Programming they might think you're busy to write Sci-Fi Book instead of yet-another-software! :D

Mahdi
– Mahdi

2012-10-11 11:46:18 +00:00
Commented Oct 11, 2012 at 11:46
Companies like that do not understand that good software live very long and the better documentation the more worth the source is.

Thorbjørn Ravn Andersen
– Thorbjørn Ravn Andersen

2018-05-11 12:45:27 +00:00
Commented May 11, 2018 at 12:45

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 »