Warning: Can't synchronize with repository "(default)" (Unsupported version control system "svn": No module named svn). Look in the Trac log for more information.

Ticket #2132 (closed enhancement: wontfix)

Opened 10 years ago

Last modified 10 years ago

[PATCH] Add __docformat__ to TG2 modules

Reported by: vinces1979 Owned by: faide
Priority: low Milestone: 2.0
Component: TurboGears Version: trunk
Severity: minor Keywords:
Cc:

Description

When running epydoc on a project that is not using restructedtext, a lot of warnings are produced which can cleaned up by specifying the module docformat.

Epydoc recommends this is used "it is recommended that you explicitly specify docformat in all your modules. ", from  http://epydoc.sourceforge.net/using.html

Attachments

tg_docformat.diff Download (4.2 KB) - added by vinces1979 10 years ago.
tg2_docformat.patch Download (3.6 KB) - added by vinces1979 10 years ago.

Change History

Changed 10 years ago by vinces1979

Changed 10 years ago by vinces1979

comment:1 Changed 10 years ago by vinces1979

  • Summary changed from [PATHC] Add __docformat__ to TG2 modules to [PATCH] Add __docformat__ to TG2 modules

comment:2 Changed 10 years ago by jorge.vargas

what about --docformat NAME, it seems to me that adding that CLI switch is a lot better than "polluting" the code base. Specially since sphinx is now the semi-official documentation tool in python.

As for the patches your first file isn't clean. it's deleting part of the code which it shouldn't. The second isn't opening for me, maybe a bad file?

-1 on applying this.

comment:3 Changed 10 years ago by mramm

-1 here too.

Particularly since we are generating module level docs from sphinx, not epydoc.

comment:4 Changed 10 years ago by jorge.vargas

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

if a user wants epydoc, he/she should use the switch it provides rather than adding cruft to TG's sources with the proposed changes.

Note: See TracTickets for help on using tickets.