Ticket #10594 (closed defect: fixed)

Opened 7 months ago

Last modified 6 months ago

[PATCH] Some options' docs are missing

Reported by: sdegrande Assigned to: hasienda
Priority: normal Component: AccountManagerPlugin
Severity: normal Keywords:
Cc: Trac Release: 1.0

Description

With r12138, on Trac 1.0, on wiki/TracIni two errors are reported, due to some missing documentation on 2 options.

Here is a proposed patch, with some very simple docs : 

Index: api.py
===================================================================
--- api.py	(revision 12277)
+++ api.py	(working copy)
@@ -163,8 +163,8 @@
 
     _password_store = OrderedExtensionsOption(
         'account-manager', 'password_store', IPasswordStore,
-        include_missing=False)
-    _password_format = Option('account-manager', 'password_format')
+        include_missing=False, doc="Ordered list of password stores, queried in turn.")
+    _password_format = Option('account-manager', 'password_format', doc="Deprecated in Trac >= 0.10")
     _register_check = OrderedExtensionsOption(
         'account-manager', 'register_check', IAccountRegistrationInspector,
         default="""BasicCheck, EmailCheck, BotTrapCheck, RegExpCheck,

Attachments

Change History

11/24/12 00:48:32 changed by hasienda

(In [12386]) AccountManagerPlugin: Add some option docs, refs #10594.

Thanks to sdegrande for taking care to report and for suggesting some strings.

12/01/12 16:55:52 changed by hasienda

  • status changed from new to closed.
  • resolution set to fixed.

(In [12398]) AccountManagerPlugin: Releasing version 0.4, pushing development to acct_mgr-0.5dev.

Availability of that code as stable release closes #874, #3459, #4677, #5295, #5691, #6616, #7577, #8076, #8685, #8770, #8791, #8990, #9052, #9079, #9090, #9139, #9246, #9252, #9547, #9618, #9676, #9843, #9852, #9940, #10023, #10028, #10123, #10142, #10204, #10276, #10397, #10412, #10594, #10625 and #10644.

Some more issues have been worked-on, yet without confirmed resolution, refs #5464 (for JiraToTracIntegration), #8927 and #10134.

And finally there are some issues and enhancement requests showing progress, but known to require more work to resolve them satisfactorily, refs #843, #1600, #5964, #8217, #8933.

Thanks to all contributors and followers, that enabled and encouraged a good portion of this development work.

Add/Change #10594 ([PATCH] Some options' docs are missing)




Change Properties
Action