View Issue Details
ID | Project | Category | View Status | Date Submitted | Last Update |
---|---|---|---|---|---|
0000392 | apt-panopticon | TODO | public | 2022-01-24 18:08 | 2023-06-20 12:27 |
Reporter | onefang | Assigned To | onefang | ||
Priority | high | Severity | text | Reproducibility | N/A |
Status | assigned | Resolution | open | ||
Product Version | 0.1 | ||||
Target Version | 0.1 | ||||
Summary | 0000392: Document the code. | ||||
Description | I've been slack. lol | ||||
Tags | No tags attached. | ||||
https://slashdot.org/story/23/06/13/0011226/ask-slashdot-what-are-some-tips-for-creating-effective-documentation?utm_source=rss1.0mainlinkanon&utm_medium=feed has some good tips. "When you need to print an error message, put it in a variable named Im_sorry_Dave_I_cant_do_that." "Refactoring code I found unsanitized user input that was being passed directly to the database. I believe the original variable name was $qp (probably short for query parameters) I renamed it $attack_payload, which was much more descriptive and clearly allowed people to see where they needed to fix security issues" |
|