#18451 Improved class based view documentation #145

Closed
wants to merge 5 commits into
from

Projects

None yet

4 participants

Contributor

Trying to help out @pydanny a little.

Added in some missing docstrings for classes and methods in the generic class-based views.

kennethlove added some commits Jun 8, 2012
@kennethlove kennethlove Updates to the edit views' docstrings.
Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
632b801
@kennethlove kennethlove Updates to the date views
Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
efe4601
@kennethlove kennethlove Updates to the base views
Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
1282938
@kennethlove kennethlove Updates to the detail views
Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
ba0e4c5
@kennethlove kennethlove Updates to the list views
Signed-off-by: Kenneth Love <kenneth@gigantuan.net>
70b9b3a
Member
mjtamlyn commented Jun 8, 2012

Looks good. The use of autodoc in the main documentation is going to go away (see @jacobian's comment on #144) but adding docstrings to undocumented functions is always a good idea!

Contributor

Yeah, I didn't see @jacobian's comment until after I had made the changes and request. Anything I contribute to docs later on, I'll try and use his recommended method.

Contributor
dbrgn commented Jun 9, 2012

If I'm not mistaken, you could file this pull request directly against @pydanny's fork, right? Then it would land in the same pull request (#144), which would make review easier :)

Member
mjtamlyn commented Jun 9, 2012

I'm merged this into #144 now, so we can close this.

@jezdez jezdez closed this Jun 10, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment