Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#8981 closed (wontfix)

adding some comments to the code

Reported by: Andrew Gibson Owned by: Andrew Gibson
Component: Database layer (models, ORM) Version: master
Severity: Keywords: [code commends]
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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)

patch.diff (6.4 KB) - added by Andrew Gibson 8 years ago.
comments

Download all attachments as: .zip

Change History (4)

Changed 8 years ago by Andrew Gibson

Attachment: patch.diff added

comments

comment:1 Changed 8 years ago by Adrian Holovaty

Resolution: wontfix
Status: newclosed

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.

comment:2 in reply to:  1 ; Changed 8 years ago by Andrew Gibson

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 in reply to:  2 Changed 8 years ago by Andrew Gibson

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?

Note: See TracTickets for help on using tickets.
Back to Top