Opened 9 years ago

Closed 9 years ago

#13707 closed (invalid)

Reflecting django docs in pydocs

Reported by: nyxtom@… Owned by: nobody
Component: Documentation Version: 1.2
Severity: Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


First, let me say that I love django's documentation. What creates a disconnect for me is finding out how to do something very quickly. A lot of times, this is helped through pydocs and poking around various libraries using bpython. A lot of functions use kwargs, so unfortunately while the django documentation might show a signature to accept a 'mimetype' parameter, it isn't necessarily noticed from the pydocs.

It would be extremely helpful to have some signatures documented in pydocs as well as providing a link to django docs. Having the link will help in being able to see examples and search other code very quickly.


Change History (1)

comment:1 Changed 9 years ago by Russell Keith-Magee

Component: UncategorizedDocumentation
Resolution: invalid
Status: newclosed

This is one of those wierd occasions where I'm in completely agreement, but I'm going to mark the ticket invalid.

The reason is entirely procedural; documentation is better handled by a series of smaller tickets, each of which fixes some specific documentation problem. That way we can easily track the work that needs to be applied to trunk.

If you want to address this, write a patch that adds docs to a specific module or group of modules (e.g., the query API), and open a new ticket that specifically addresses the area that you are documenting.

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