Ticket #362 (closed defect: fixed)

Opened 5 years ago

Last modified 4 years ago

fileIsImportant is not well documented

Reported by: clepple Owned by: clepple
Priority: minor Milestone: 0.7.10
Version: 0.7.9 Keywords:
Cc:

Description

The fileIsImportant function could use some more documentation. Also, there are a few instances of "isFileImportant" in the manual.

Hopefully I will have time to whip up a patch to the .info file and epydoc for the class, but feel free to remind me if it's been a while.

Attachments

fileIsImportant-docs.patch Download (2.0 KB) - added by clepple 5 years ago.
patch for buildbot.texinfo

Change History

Changed 5 years ago by clepple

patch for buildbot.texinfo

comment:1 Changed 5 years ago by clepple

  • Owner set to clepple
  • Status changed from new to assigned

Any objections to creating another section in the manual for the fileIsImportant function?

There are a number of places that reference it, and there is actually a sizable paragraph duplicated in each place.

comment:2 Changed 4 years ago by dustin

  • Milestone changed from undecided to 0.7.10

No, no objections whatsoever to doc fixes! :)

fileIsImportant-docs.patch is committed:

Created commit cd6a16c: (refs #362) docs changes (fileIsImportant)
 1 files changed, 15 insertions(+), 6 deletions(-)

keep 'em coming!

comment:3 Changed 4 years ago by dustin

  • Status changed from assigned to closed
  • Resolution set to fixed
Note: See TracTickets for help on using tickets.