Opened 4 years ago

Closed 4 years ago

#6046 task closed fixed (fixed)

Missing documentation for FilePath

Reported by: thijs Owned by: thijs
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: thijs Branch: branches/filepath-docs-6046
branch-diff, diff-cov, branch-cov, buildbot
Author: exarkun


The documentation for FilePath has some "No summary" and "Undocumented" methods listed, the attached patch fills in those blanks.

Attachments (1)

filepath-doc-6046.patch (21.4 KB) - added by thijs 4 years ago.

Download all attachments as: .zip

Change History (8)

Changed 4 years ago by thijs

comment:1 Changed 4 years ago by tom.prince

  • Keywords review removed
  • Owner set to thijs
  • {{{_PathHelper}} doesn't actually exist (it is referenced in one the doc strings
  • There are quite a few places that change L{} to C{} for no apparent reason. Or introduce C{} where L{} would work.
  • twistedchecker reports a number of docstring errors after this patch (although less than before).

Feel free to commit after fixing.


  • There are a number of places (basename and splitext for example, where the description of the function and the return value are essentially the same. It would be nice to simplify one of them (probably the return value).

comment:2 Changed 4 years ago by exarkun

  • Author set to exarkun
  • Branch set to branches/filepath-docs-6046

(In [36624]) Branching to 'filepath-docs-6046'

comment:3 Changed 4 years ago by exarkun

(In [36625]) Apply filepath-doc-6046.patch

refs #6046

comment:4 Changed 4 years ago by exarkun

(In [36626]) adjust a bunch of C{} to L{}; fix some other minor issues

refs #6046

comment:5 Changed 4 years ago by exarkun

(In [36628]) some more doc fixes, mostly pointed out by twistedchecker

refs #6046

comment:7 Changed 4 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

(In [36631]) Merge filepath-docs-6046

Author: thijs, exarkun Reviewer: tom.prince Fixes: #6046

Various improvements to the API documentation content and markup of twisted.python.filepath.

Note: See TracTickets for help on using tickets.