Modify

Opened 5 years ago

Last modified 5 years ago

#4909 new enhancement

[PATCH] Add class documentation to appear in [[WikiMacros]] call

Reported by: kontakt at meitzner dot net Owned by: gotoh
Priority: low Component: TicketBoxMacro
Severity: trivial Keywords:
Cc: Trac Release: 0.11

Description

As my users are ancouraged to make use of all the TracWiki magic they want to express themselves, I like to have all those possibilities well documented. However, when I looked at the WikiMacros Page after having installed TicketBoxMacro, I noticed that [[TicketBox]] only had the word "None" showing up as documentation.

So I did a little hacking and basically just copied the doc lines from the beginning of TicketBox.py to just after the class definition, so it gets rendered by a [[WikiMacros]] call.

I've svn-diffed it and attached it as a patch, though it's trivial after all. If you decide to use it, please remember to change all two instances of the documentation when you change sth therein. (Maybe one could put it in a variable to re-use it, but I'm all new to python as of now.)

Attachments (1)

wikimakros_doc.patch (2.7 KB) - added by kontakt at meitzner dot net 5 years ago.
Re-used Macro documentation for class documentation to show up in a WikiMacros call

Download all attachments as: .zip

Change History (2)

Changed 5 years ago by kontakt at meitzner dot net

Re-used Macro documentation for class documentation to show up in a WikiMacros call

comment:1 Changed 5 years ago by kontakt at meitzner dot net

Darn, shoulda escaped that [[WikiMacros]] in the upload description, too... sorry for that.

Add Comment

Modify Ticket

Action
as new .
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.