Merge pull request #232 from gferreira/master

updating representation docs, converting lists of notifications to lists (WIP)

Lib/defcon/objects/anchor.py

@@ -12,16 +12,12 @@ class Anchor(BaseDictObject):
 
     **This object posts the following notifications:**
 
-    ========================
-    Name
-    ========================
-    Anchor.Changed
-    Anchor.XChanged
-    Anchor.YChanged
-    Anchor.NameChanged
-    Anchor.ColorChanged
-    Anchor.IdentifierChanged
-    ========================
+    - Anchor.Changed
+    - Anchor.XChanged
+    - Anchor.YChanged
+    - Anchor.NameChanged
+    - Anchor.ColorChanged
+    - Anchor.IdentifierChanged
 
     During initialization an anchor dictionary can be passed. If so,
     the new object will be populated with the data from the dictionary.

Lib/defcon/objects/base.py

@@ -9,15 +9,11 @@ class BaseObject(object):
 
     **This object posts the following notifications:**
 
-    ====================
-    Name
-    ====================
-    BaseObject.Changed
-    BaseObject.BeginUndo
-    BaseObject.EndUndo
-    BaseObject.BeginRedo
-    BaseObject.EndRedo
-    ====================
+    - BaseObject.Changed
+    - BaseObject.BeginUndo
+    - BaseObject.EndUndo
+    - BaseObject.BeginRedo
+    - BaseObject.EndRedo
 
     Keep in mind that subclasses will not post these same notifications.
 

Lib/defcon/objects/component.py

@@ -16,15 +16,12 @@ class Component(BaseObject):
 
     **This object posts the following notifications:**
 
-    ===============================
-    Name
-    ===============================
-    Component.Changed
-    Component.BaseGlyphChanged
-    Component.BaseGlyphDataChanged
-    Component.TransformationChanged
-    Component.IdentifierChanged
-    ===============================
+    - Component.Changed
+    - Component.BaseGlyphChanged
+    - Component.BaseGlyphDataChanged
+    - Component.TransformationChanged
+    - Component.IdentifierChanged
+
     """
 
     changeNotificationName = "Component.Changed"

Lib/defcon/objects/contour.py

@@ -18,14 +18,10 @@ class Contour(BaseObject):
 
     **This object posts the following notifications:**
 
-    ===============================
-    Name
-    ===============================
-    Contour.Changed
-    Contour.WindingDirectionChanged
-    Contour.PointsChanged
-    Contour.IdentifierChanged
-    ===============================
+    - Contour.Changed
+    - Contour.WindingDirectionChanged
+    - Contour.PointsChanged
+    - Contour.IdentifierChanged
 
     The Contour object has list like behavior. This behavior allows you to interact
     with point data directly. For example, to get a particular point::

Lib/defcon/objects/dataSet.py

@@ -12,11 +12,7 @@ class DataSet(BaseObject):
 
     **This object posts the following notifications:**
 
-    ===============
-    Name
-    ===============
-    DataSet.Changed
-    ===============
+    - DataSet.Changed
 
     """
 

Lib/defcon/objects/features.py

@@ -10,16 +10,13 @@ class Features(BaseObject):
 
     **This object posts the following notifications:**
 
-    ================
-    Name
-    ================
-    Features.Changed
-    Features.BeginUndo
-    Features.EndUndo
-    Features.BeginRedo
-    Features.EndRedo
-    Features.TextChanged
-    ================
+    - Features.Changed
+    - Features.BeginUndo
+    - Features.EndUndo
+    - Features.BeginRedo
+    - Features.EndRedo
+    - Features.TextChanged
+
     """
 
     changeNotificationName = "Features.Changed"

Lib/defcon/objects/font.py

@@ -36,15 +36,11 @@ class Font(BaseObject):
 
     **This object posts the following notifications:**
 
-    ======================
-    Name
-    ======================
-    Font.Changed
-    Font.ReloadedGlyphs
-    Font.GlyphOrderChanged
-    Font.GuidelinesChanged
-    Font.GuidelineWillBeDeleted
-    ======================
+    - Font.Changed
+    - Font.ReloadedGlyphs
+    - Font.GlyphOrderChanged
+    - Font.GuidelinesChanged
+    - Font.GuidelineWillBeDeleted
 
     The Font object has some dict like behavior. For example, to get a glyph::
 

Lib/defcon/objects/glyph.py

@@ -33,38 +33,34 @@ class Glyph(BaseObject):
 
     **This object posts the following notifications:**
 
-    ============================
-    Name
-    ============================
-    Glyph.Changed
-    Glyph.BeginUndo
-    Glyph.EndUndo
-    Glyph.BeginRedo
-    Glyph.EndRedo
-    Glyph.NameWillChange
-    Glyph.NameChanged
-    Glyph.UnicodesChanged
-    Glyph.WidthChanged
-    Glyph.HeightChanged
-    Glyph.NoteChanged
-    Glyph.LibChanged
-    Glyph.ImageChanged
-    Glyph.ImageWillBeDeleted
-    Glyph.ContourWillBeAdded
-    Glyph.ContourWillBeDeleted
-    Glyph.ContoursChanged
-    Glyph.ComponentWillBeAdded
-    Glyph.ComponentWillBeDeleted
-    Glyph.ComponentsChanged
-    Glyph.AnchorWillBeAdded
-    Glyph.AnchorWillBeDeleted
-    Glyph.AnchorsChanged
-    Glyph.GuidelineWillBeAdded
-    Glyph.GuidelineWillBeDeleted
-    Glyph.GuidelinesChanged
-    Glyph.MarkColorChanged
-    Glyph.VerticalOriginChanged
-    ============================
+    - Glyph.Changed
+    - Glyph.BeginUndo
+    - Glyph.EndUndo
+    - Glyph.BeginRedo
+    - Glyph.EndRedo
+    - Glyph.NameWillChange
+    - Glyph.NameChanged
+    - Glyph.UnicodesChanged
+    - Glyph.WidthChanged
+    - Glyph.HeightChanged
+    - Glyph.NoteChanged
+    - Glyph.LibChanged
+    - Glyph.ImageChanged
+    - Glyph.ImageWillBeDeleted
+    - Glyph.ContourWillBeAdded
+    - Glyph.ContourWillBeDeleted
+    - Glyph.ContoursChanged
+    - Glyph.ComponentWillBeAdded
+    - Glyph.ComponentWillBeDeleted
+    - Glyph.ComponentsChanged
+    - Glyph.AnchorWillBeAdded
+    - Glyph.AnchorWillBeDeleted
+    - Glyph.AnchorsChanged
+    - Glyph.GuidelineWillBeAdded
+    - Glyph.GuidelineWillBeDeleted
+    - Glyph.GuidelinesChanged
+    - Glyph.MarkColorChanged
+    - Glyph.VerticalOriginChanged
 
     The Glyph object has list like behavior. This behavior allows you to interact
     with contour data directly. For example, to get a particular contour::

Lib/defcon/objects/groups.py

@@ -11,19 +11,15 @@ class Groups(BaseDictObject):
 
     **This object posts the following notifications:**
 
-    ===================
-    Name
-    ===================
-    Groups.Changed
-    Groups.BeginUndo
-    Groups.EndUndo
-    Groups.BeginRedo
-    Groups.EndRedo
-    Groups.GroupSet
-    Groups.GroupDeleted
-    Groups.Cleared
-    Groups.Updated
-    ===================
+    - Groups.Changed
+    - Groups.BeginUndo
+    - Groups.EndUndo
+    - Groups.BeginRedo
+    - Groups.EndRedo
+    - Groups.GroupSet
+    - Groups.GroupDeleted
+    - Groups.Cleared
+    - Groups.Updated
 
     This object behaves like a dict. The keys are group names and the
     values are lists of glyph names::

Lib/defcon/objects/guideline.py

@@ -12,16 +12,12 @@ class Guideline(BaseDictObject):
 
     **This object posts the following notifications:**
 
-    ===========================
-    Name
-    ===========================
-    Guideline.Changed
-    Guideline.XChanged
-    Guideline.YChanged
-    Guideline.AngleChanged
-    Guideline.NameChanged
-    Guideline.IdentifierChanged
-    ===========================
+    - Guideline.Changed
+    - Guideline.XChanged
+    - Guideline.YChanged
+    - Guideline.AngleChanged
+    - Guideline.NameChanged
+    - Guideline.IdentifierChanged
 
     During initialization a guideline dictionary, following the format defined
     in the UFO spec, can be passed. If so, the new object will be populated

Lib/defcon/objects/image.py

@@ -20,15 +20,11 @@ class Image(BaseDictObject):
 
     **This object posts the following notifications:**
 
-    ===========================
-    Name
-    ===========================
-    Image.Changed
-    Image.FileNameChanged
-    Image.TransformationChanged
-    Image.ColorChanged
-    Image.ImageDataChanged
-    ===========================
+    - Image.Changed
+    - Image.FileNameChanged
+    - Image.TransformationChanged
+    - Image.ColorChanged
+    - Image.ImageDataChanged
 
     During initialization an image dictionary, following the format defined
     in the UFO spec, can be passed. If so, the new object will be populated

Lib/defcon/objects/imageSet.py

@@ -18,17 +18,13 @@ class ImageSet(BaseObject):
 
     **This object posts the following notifications:**
 
-    ===========================
-    Name
-    ===========================
-    ImageSet.Changed
-    ImageSet.FileNamesChanged
-    ImageSet.ImageChanged
-    ImageSet.ImageWillBeAdded
-    ImageSet.ImageAdded
-    ImageSet.ImageWillBeDeleted
-    ImageSet.ImageDeleted
-    ===========================
+    - ImageSet.Changed
+    - ImageSet.FileNamesChanged
+    - ImageSet.ImageChanged
+    - ImageSet.ImageWillBeAdded
+    - ImageSet.ImageAdded
+    - ImageSet.ImageWillBeDeleted
+    - ImageSet.ImageDeleted
 
     This object behaves like a dict. For example, to get the
     raw image data for a particular image::

Lib/defcon/objects/info.py

@@ -59,16 +59,12 @@ class Info(BaseObject):
 
     **This object posts the following notifications:**
 
-    ===========================
-    Name
-    ===========================
-    Info.Changed
-    Info.BeginUndo
-    Info.EndUndo
-    Info.BeginRedo
-    Info.EndRedo
-    Info.ValueChanged
-    ===========================
+    - Info.Changed
+    - Info.BeginUndo
+    - Info.EndUndo
+    - Info.BeginRedo
+    - Info.EndRedo
+    - Info.ValueChanged
 
     **Note:** The documentation strings here were automatically generated
     from the `UFO specification <http://unifiedfontobject.org/filestructure/fontinfo.html>`_.

Lib/defcon/objects/kerning.py

@@ -11,19 +11,15 @@ class Kerning(BaseDictObject):
 
     **This object posts the following notifications:**
 
-    ===================
-    Name
-    ===================
-    Kerning.Changed
-    Kerning.BeginUndo
-    Kerning.EndUndo
-    Kerning.BeginRedo
-    Kerning.EndRedo
-    Kerning.PairSet
-    Kerning.PairDeleted
-    Kerning.Cleared
-    Kerning.Updated
-    ====================
+    - Kerning.Changed
+    - Kerning.BeginUndo
+    - Kerning.EndUndo
+    - Kerning.BeginRedo
+    - Kerning.EndRedo
+    - Kerning.PairSet
+    - Kerning.PairDeleted
+    - Kerning.Cleared
+    - Kerning.Updated
 
     This object behaves like a dict. For example, to get a list of all kerning pairs::