Commits

Patrick Mézard committed 79aacd3

obsolete: simplify module docstring

  • Participants
  • Parent commits f46a410
  • Branches default

Comments (0)

Files changed (1)

File hgext/obsolete.py

 General concept
 ===============
 
-This extension introduces the *obsolete* concept. It adds a new *obsolete*
-relation between two changesets. A relation ``<changeset B> obsolete <changeset
-A>`` is set to denote that ``<changeset B>`` is new version of ``<changeset
-A>``.
+This extension introduces the *obsolete* concept. The relation
+``<changeset B> obsoletes <changeset A>`` denotes that ``<changeset B>``
+is a new version of ``<changeset A>``.
 
-The *obsolete* relation act as a **perpendicular history** to the standard
-changeset history. Standard changeset history versions files. The *obsolete*
-relation versions changesets.
+The *obsolete* relations act as an history **orthogonal** to the regular
+changesets history. Regular changesets history versions files. *Obsolete*
+relations version changesets.
 
 :obsolete:     a changeset that has been replaced by another one.
 :unstable:     a changeset that is not obsolete but has an obsolete ancestor.
-:suspended:    an obsolete changeset with unstable descendant.
-:extinct:      an obsolete changeset without unstable descendant.
+:suspended:    an obsolete changeset with unstable descendants.
+:extinct:      an obsolete changeset without unstable descendants.
                (subject to garbage collection)
 
 Another name for unstable could be out of sync.