= 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/''' 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/'''''' page. //Notable changesets modifying the API prior to 1.0 have been recorded in [./@15#DevelopmentMilestones a previous version] of this page.