Changeset 33013 in project


Ignore:
Timestamp:
12/20/15 00:53:19 (4 years ago)
Author:
John Croisant
Message:

sdl2: Better explain API stability guarantees.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/sdl2

    r33005 r33013  
    149149
    150150
    151 == Backwards Compatibility and Stability
    152 
    153 The sdl2 egg follows "[[http://semver.org/|semantic versioning]]". The
    154 API is not stable until version 1.0 is released. That means the API
    155 may change in ways that break backwards compatibility with previous
    156 versions. After version 1.0 is released, the API will remain stable
    157 (no backwards-incompatible changes) until the next new major version
    158 (e.g. going from version 1.x to 2.0, or 2.x to 3.0).
    159 
    160 The sdl2 egg's API is not cross-compatible with the [[/egg/sdl-base|sdl-base egg]].
    161 
    162 
    163151== API
    164152
    165153=== About the API
     154
     155==== API Stability
     156
     157The sdl2 egg follows "[[http://semver.org/|semantic versioning]]".
     158Until version 1.0.0 is released, the API is not guaranteed to be "stable".
     159That means the maintainer reserves the right to change the API if needed,
     160possibly in ways that break backwards compatibility with previous versions.
     161'''Large backwards-incompatible changes are unlikely''',
     162but there may be small tweaks and fixes to the API if problems are discovered.
     163
     164After version 1.0.0 is released, the API is guaranteed to remain stable (no backwards-incompatible changes)
     165until the next new major version (e.g. going from version 1.x to 2.0.0, or 2.x to 3.0.0).
    166166
    167167==== Conventions
Note: See TracChangeset for help on using the changeset viewer.