summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Shumaker <LukeShu@sbcglobal.net>2014-02-10 21:20:31 -0500
committerLuke Shumaker <LukeShu@sbcglobal.net>2014-02-10 21:20:31 -0500
commit791f0eec02f274010e051b55d436921b873d9095 (patch)
treee84b976f7c1a83d6d9dc624826edbc064074957f
parent4945ce02b45dacee020f8919f51fa3dfb23cc194 (diff)
finish? the main DesignDocument.md
-rw-r--r--docs/DesignDocument.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md
index 885e679..73b050d 100644
--- a/docs/DesignDocument.md
+++ b/docs/DesignDocument.md
@@ -374,7 +374,7 @@ TeamsController
The following methods respond to POST requests, assuming the user
has permission:
- - `update()` TODO: POST
+ - `update()` Update the specified `Team` with the POSTed data.
UsersController
: The following methods respond to GET requests by rendering the
@@ -388,10 +388,19 @@ UsersController
The following methods respond to POST requests, assuming the user
has permission:
- - `create()` TODO: POST
- - `update()` TODO: POST
- - `delete()` TODO: POST
+ - `create()` Creates a new `User` with the POSTed data.
+ - `update()` Update the specified `User` with the POSTed data.
+ - `delete()` Deletes the specified `User` account.
## UML Diagram of Classes
+This diagram does not show all models inheriting from
+`ActiveRecord::Base`, all views inheriting from `layouts/application`,
+or all controllers inheriting from `ApplicationController`. It
+does not show interactions with the `User` model that solely check
+authorization to perform an action. It does not show controller
+methods calling the error views. It shows transitions from a view to
+a controller *only* when that is the *primary* purpose of the view; many
+workflows can be interupted at any time.
+
![](DesignDocument-classes.pdf)\