Edgewall Software

Opened 10 years ago

Closed 10 years ago

Last modified 9 years ago

#11532 closed enhancement (fixed)

Remove description of defaults values from option help

Reported by: Ryan J Ollos Owned by: Ryan J Ollos
Priority: normal Milestone: 1.1.2
Component: general Version:
Severity: normal Keywords: documentation
Cc: Branch:
Release Notes:

Removed listing of default values from option documentation. The default values aren't needed in the description since the TracIni macro outputs a column with the default value, and removing them makes the documentation more accurate and easier to maintain.

API Changes:
Internal Changes:

Description (last modified by Ryan J Ollos)

On the trunk, the documentation for permission_policies is out-of-date after #11244. The documentation states:

Defaults to the DefaultPermissionPolicy (pre-0.11 behavior) and LegacyAttachmentPolicy (map ATTACHMENT_* permissions to realm specific ones)

Since #9351, the TracIni macro displays the correct default value which is: ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy.

Therefore I propose to remove the documentation for each option that describes the default values.

Attachments (0)

Change History (8)

comment:1 by Ryan J Ollos, 10 years ago

Description: modified (diff)

comment:2 by Ryan J Ollos, 10 years ago

Milestone: next-stable-1.0.x1.0.2
Owner: set to Ryan J Ollos
Status: newassigned

comment:3 by Ryan J Ollos, 10 years ago


comment:4 by Ryan J Ollos, 10 years ago

Proposed changes can be found in log:rjollos.git:t11532.

comment:5 by Ryan J Ollos, 10 years ago

Release Notes: modified (diff)
Resolution: fixed
Status: assignedclosed

Committed to trunk in [12632].

comment:6 by Ryan J Ollos, 10 years ago

Release Notes: modified (diff)

comment:7 by Ryan J Ollos, 10 years ago

Keywords: documentation added

comment:8 by Ryan J Ollos, 9 years ago

[12632#file21] added markup inside a code block. Fixed in [13708].

Modify Ticket

Change Properties
Set your email in Preferences
as closed The owner will remain Ryan J Ollos.
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from Ryan J Ollos to the specified user.

Add Comment

E-mail address and name can be saved in the Preferences .
Note: See TracTickets for help on using tickets.