Modify ↓

Opened 12 years ago

Closed 12 years ago

#9769 closed enhancement (fixed)

Refactor code and improve documentation

Reported by: Ryan J Ollos Owned by: Ryan J Ollos
Priority: normal Component: PlantUmlMacro
Severity: normal Keywords:
Cc: Álvaro Iradier Trac Release: 0.11

Description

The source will be refactored and the documentation improved in this ticket.

Attachments (0)

Change History (9)

comment:1 Changed 12 years ago by Ryan J Ollos

(In [11253]) Refs #9769:

  • Remove the PlantUMLRenderer class. The PlantUMLMacro can implement the IRequestInterface, and now only one component needs to be enabled to activate the plugin.
  • Added setup.cfg and labeled builds with dev.
  • Bumped revision to 1.3 (currently 1.3dev).
  • Added new maintainer to setup.py.

comment:2 Changed 12 years ago by Ryan J Ollos

(In [11387]) Refs #9769: Renamed TracPlantUmlPlugin to PlantUmlMacro. The SVN ACLs have been changed accordingly.

comment:3 Changed 12 years ago by Ryan J Ollos

Status: new → assigned

Project was renamed from TracPlantUmlPlugin to PlantUmlMacro for consistency with generally accepted plugin and macro naming conventions using throughout t-h.o. There is now a redirect at TracPlantUmlPlugin that points back to PlantUmlMacro. A few changes need to be made to the source code. I'll do that next.

comment:4 Changed 12 years ago by Ryan J Ollos

(In [11389]) Refs #9769: Changed setup.py to account for a change in the project's URL. Added Installation error hints to some error messages. Added the example from the project's wiki page to the module's help text, which will appear on the WikiMacros page. Deleted a non-existent module from all.

comment:5 Changed 12 years ago by Ryan J Ollos

(In [11397]) Refs #9769: Renamed 0.11 directory to trunk, to make it more obvious that this works with all Trac version >= 0.11. branches and tags will be created as needed.

comment:6 Changed 12 years ago by Ryan J Ollos

(In [11399]) Refs #9769: Part of [11397].

comment:7 Changed 12 years ago by Ryan J Ollos

(In [11479]) Refs #9769: Improved documentation example.

comment:8 Changed 12 years ago by Ryan J Ollos

(In [11480]) Refs #9769: Improved documentation for the TracIni page.

comment:9 Changed 12 years ago by Ryan J Ollos

Resolution: → fixed
Status: assigned → closed

Ticket will be closed now since the documentation is considered complete. Feedback welcome.

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Ryan J Ollos.
The resolution will be deleted. Next status will be 'reopened'.

Add Comment

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

Attachments ↑ Description ↑
 
Note: See TracTickets for help on using tickets.