Permalink
Browse files

fix items in README

  • Loading branch information...
1 parent 57e76fe commit 480fb5d718331ed7ab9d4507b0d120364986bb66 @semmypurewal committed Jul 10, 2012
Showing with 26 additions and 26 deletions.
  1. +26 −26 README.md
View
@@ -115,49 +115,49 @@ Right now, you can do the following with a Model object:
##attribute related
-*hasA -- creates an encapsulated attribute
-*hasAn -- syntactic sugar for hasA
-*hasMany -- creates an encapsulated list of encapsulated attributes
-*attributes -- returns an array of attribute names as strings
-*attribute -- returns the specified Attr or AttrList object
-*parent -- returns the constructor of the parent, if one exists
+* hasA -- creates an encapsulated attribute
+* hasAn -- syntactic sugar for hasA
+* hasMany -- creates an encapsulated list of encapsulated attributes
+* attributes -- returns an array of attribute names as strings
+* attribute -- returns the specified Attr or AttrList object
+* parent -- returns the constructor of the parent, if one exists
## method related
-*respondsTo -- creates a method
-*methods -- returns an array of method names as string
-*method -- returns the specified Method object
+* respondsTo -- creates a method
+* methods -- returns an array of method names as string
+* method -- returns the specified Method object
## constructor related
-*isBuiltWith -- accepts a series of strings that should be attributes, those prepended with '%' are optional in the constructor
+* isBuiltWith -- accepts a series of strings that should be attributes, those prepended with '%' are optional in the constructor
-- also accepts an initializer as the final argument
## modifier
-*isImmutable -- makes the object immutable and forces all attributes to be required in an isBuiltWith call
+* isImmutable -- makes the object immutable and forces all attributes to be required in an isBuiltWith call
## inheritance
-*isA -- inherits from the specified model
-*isAn -- syntactic sugar for isA
+* isA -- inherits from the specified model
+* isAn -- syntactic sugar for isA
Attr and AttrList objects respond to the following methods:
-*validatesWith -- accepts a function that returns true if the parameter is valid for the attribute
-*defaultsTo -- accepts a default value for the attribute (not currently available for AttrList)
-*isImmutable -- makes it so the attribute cannot be changed once it is set
-*addTo -- accepts an object to attach this attribute to
-*and -- syntactic sugar, a pointer to the Attr object
-*which -- syntactic sugar, a pointer to the Attr object
-*eachOfWhich -- syntactic sugar, a pointer to the Attr object
+* validatesWith -- accepts a function that returns true if the parameter is valid for the attribute
+* defaultsTo -- accepts a default value for the attribute (not currently available for AttrList)
+* isImmutable -- makes it so the attribute cannot be changed once it is set
+* addTo -- accepts an object to attach this attribute to
+* and -- syntactic sugar, a pointer to the Attr object
+* which -- syntactic sugar, a pointer to the Attr object
+* eachOfWhich -- syntactic sugar, a pointer to the Attr object
Attr and AttrList objects also have the following built-in validators
-*isGreaterThan
-*isLessThan
-*isA
-*isOneOf
+* isGreaterThan
+* isLessThan
+* isA
+* isOneOf
You can set up your own validators by using the validatesWith or validateWith methods.
Here, you set the error message with 'this.message'
@@ -179,5 +179,5 @@ AttrList also aliases 'validateWith' for 'validatesWith' to maintain grammatical
We hope to add the following self-explanatory functionality to Attr and AttrList:
-*isNotNull
-*isNotUndefined
+* isNotNull
+* isNotUndefined

0 comments on commit 480fb5d

Please sign in to comment.