Edgewall Software

Opened 9 years ago

Closed 9 years ago

Last modified 9 years ago

#11824 closed enhancement (fixed)

Remove //Since// version information from TracIni documentation — at Version 7

Reported by: Ryan J Ollos Owned by: Ryan J Ollos
Priority: normal Milestone: 1.1.3
Component: general Version:
Severity: normal Keywords: trac.ini ​documentation
Cc: Branch:
Release Notes:

Removed from documentation the version in which a configuration option was added for versions of Trac < 0.12.

API Changes:

Leading and trailing whitespace is stripped from translatable string (plugin developers should use cleandoc from trac.util). Previously only uniform indentation was removed.

Internal Changes:

Description

Discussed on the mailing list in ​gmessage:trac-dev:c136Ptgl_WU/FeZNjNkR06YJ, the Since x.y version information will be removed for Trac < 0.12.

Change History (7)

comment:1 by Ryan J Ollos, 9 years ago

Release Notes: modified (diff)

Proposed changes in log:rjollos.git:t11824.

comment:2 by Steffen Hoffmann, 9 years ago

Did you miss the ("enabled" added in 0.11), or was it intentional to keep just that one in trac/config.py? Other changes look right. Thanks for taking care to clean this up.

in reply to:  2 comment:3 by Ryan J Ollos, 9 years ago

Replying to shoffmann:

Did you miss the ("enabled" added in 0.11), or was it intentional to keep just that one in trac/config.py? Other changes look right. Thanks for taking care to clean this up.

Yeah, I wasn't consistent in changing the API documentation. I was wondering whether the same approach should be taken, removing mentions of Trac < 0.12, or if the Trac 0.11 documentation might still be useful for plugin developers.

We should probably just remove mention of Trac < 0.12 from the API documentation too, but I'll just save all changes to the API documentation for another ticket and take a consistent approach when making the changes.

comment:4 by Ryan J Ollos, 9 years ago

Committed to trunk in [13304].

I was using the PEP-0008 ​docstring conventions, putting the trailing """ on a separate line for multiline strings.

However, cleandoc doesn't strip the trailing whitespace for cases like this: trunk/trac/search/web_ui.py@:50#L39​ 

#: trac/search/web_ui.py:48
msgid ""
"Minimum length of query string allowed when performing a search.\n"
"        "
msgstr ""

I propose a fix for this in log:rjollos.git:t11824.1.

in reply to:  4 ; comment:5 by Christian Boos, 9 years ago

Replying to rjollos:

I propose a fix for this in log:rjollos.git:t11824.1.

Be careful, cleandoc_ is a keyword for message extraction (see setup.cfg), so using it for things like cleandoc_(m) is wrong (not sure if it triggers an error, but it doesn't feel right).

in reply to:  5 comment:6 by Ryan J Ollos, 9 years ago

Replying to cboos:

Be careful, cleandoc_ is a keyword for message extraction (see setup.cfg), so using it for things like cleandoc_(m) is wrong (not sure if it triggers an error, but it doesn't feel right).

Thanks, I guess I was unlucky enough that it didn't blow up! I've reworked the changes in log:rjollos.git:t11824.2.

comment:7 by Ryan J Ollos, 9 years ago

API Changes: modified (diff)
Resolution: → fixed
Status: new → closed

Changes from comment:6 committed in [13311]. New extraction in [13312]. I did some testing by modifying po files, however I'm sure I don't have as good of an eye towards potential problems as translators do. Please let me know if you spot any issues.

Note: See TracTickets for help on using tickets.