Edgewall Software
Home
Trac
Trac Hacks
Genshi
Babel
Bitten
Home
Download
Documentation
Mailing Lists
License
FAQ
Search:
Login
Preferences
Help/Guide
About Trac
Wiki
Timeline
Roadmap
Browse Source
View Tickets
New Ticket
Search
Context Navigation
-1
Start Page
Index
History
Editing TracDev/ApiChanges
Adjust edit area height:
8
12
16
20
24
28
32
36
40
Edit side-by-side
= Evolution of the Trac API == Detailed changes per version == !TracDev/ApiChanges/ **[[TitleIndex(TracDev/ApiChanges/,hideprefix,format=compact, exclude=TracDev/ApiChanges/1.1.*)]]** See also the ApiDocs themselves. == Guidelines for API changes **Always try to maintain API compatibility.** If an interface ''must'' be changed: * try to maintain the old interface for at least one minor version change (e.g. [milestone:0.10] -> [milestone:0.11]) * log deprecation warnings if the old method is used * document the API change: - in '''!TracDev/ApiChanges/<version>''' or in the //API changes// field of the corresponding ticket if any. - in the docstring, make use of the [http://sphinx.pocoo.org/markup/para.html?highlight=versionadded#directive-versionchanged .. versionmodified::] and `.. deprecated::` directives. If the old interface can't be maintained, document it as such in the appropriate !TracDev/ApiChanges/'''<version>''' page. //Notable changesets modifying the API prior to 1.0 have been recorded in [./@15#DevelopmentMilestones a previous version] of this page.
Note:
See
WikiFormatting
and
TracWiki
for help on editing wiki content.
Change information
Your email or username:
E-mail address and name can be saved in the
Preferences
Comment about this change (optional):
Note:
See
TracWiki
for help on using the wiki.