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.
-
1+1, I do think that documentation, which rapidly changes, should be extracted from source code. It's less painful for the developer.lurkerbelow– lurkerbelow2012-07-23 20:44:20 +00:00Commented Jul 23, 2012 at 20:44
-
+1: Decent advises overall, but unfortunately you can't cover all your "code related issues" with unit tests (UI dev being prime example). Wish it was so though!k.m– k.m2012-07-23 20:56:40 +00:00Commented Jul 23, 2012 at 20:56
-
@jimmy: while you can't write a useful unit test for GUI layout, you can certainly test actions and invocation of back-end logicparsifal– parsifal2012-07-23 21:08:50 +00:00Commented Jul 23, 2012 at 21:08
-
if I keep "motivations behind design decisions for parts of API", in the code / comments, my source files will explode. Instead, I track these in much details in issue tracker and only refer to respective ticket in code commentsgnat– gnat2012-07-24 00:12:09 +00:00Commented Jul 24, 2012 at 0:12
Add a comment
|
How to Edit
- 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
How to Format
-
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>
How to Tag
A tag is a keyword or label that categorizes your question with other, similar questions. Choose one or more (up to 5) tags that will help answerers to find and interpret your question.
- complete the sentence: my question is about...
- use tags that describe things or concepts that are essential, not incidental to your question
- favor using existing popular tags
- read the descriptions that appear below the tag
If your question is primarily about a topic for which you can't find a tag:
- combine multiple words into single-words with hyphens (e.g. design-patterns), up to a maximum of 35 characters
- creating new tags is a privilege; if you can't yet create a tag you need, then post this question without it, then ask the community to create it for you