#8981 closed (wontfix)
adding some comments to the code
| Reported by: | Andrew Gibson | Owned by: | Andrew Gibson |
|---|---|---|---|
| Component: | Database layer (models, ORM) | Version: | dev |
| Severity: | Keywords: | [code commends] | |
| Cc: | Triage Stage: | Unreviewed | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
I'd like to try and start contributing to django, so i've been reading the source to better understand how things work. I figured I could contribute what I've learned as comments for whoever comes after me.
Attachments (1)
Change History (4)
by , 16 years ago
| Attachment: | patch.diff added |
|---|
follow-up: 2 comment:1 by , 16 years ago
| Resolution: | → wontfix |
|---|---|
| Status: | new → closed |
While I agree that the particular section of Django could be commented more heavily, the comments in this patch aren't clear enough for inclusion.
follow-up: 3 comment:2 by , 16 years ago
Replying to adrian:
While I agree that the particular section of Django could be commented more heavily, the comments in this patch aren't clear enough for inclusion.
Could you give me an idea as to how I could improve the clarity of the comments? Should I give a longer introduction to explain everything? Provide more detail, I deliberately tried to keep it brief, but I can be quite long winded and go on and on:) Give examples in the comments?
I appreciate any feedback.
comment:3 by , 16 years ago
Replying to mysliceof314:
Replying to adrian:
While I agree that the particular section of Django could be commented more heavily, the comments in this patch aren't clear enough for inclusion.
Could you give me an idea as to how I could improve the clarity of the comments? Should I give a longer introduction to explain everything? Provide more detail, I deliberately tried to keep it brief, but I can be quite long winded and go on and on:) Give examples in the comments?
I appreciate any feedback.
Is it preferred that only contributors with demonstrated experience comment the code?
comments