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

1

Thank you, this is very helpful. I will try to incorporate some of these practices in my code from now on.

Sir Falk
– Sir Falk

2024-01-09 20:52:16 +00:00
Commented Jan 9, 2024 at 20:52
Close enough to what I was thinking of writing: all variants are missing function documentation, which informs both the caller of the function and the reader of the function code understanding what the function is supposed to do. Sure, that can be wrong (especially with copy-pasta) but no more so than the code inside the function.

jmoreno
– jmoreno

2024-01-10 01:11:48 +00:00
Commented Jan 10, 2024 at 1:11

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 »