Commits

Anonymous committed 56a5a85

Tidy the documentation.

Signed-off-by: Andy Bennett <andyjpb@knodium.com>

Comments (0)

Files changed (1)

rest-bind.svnwiki

 
 <syntax>(define-method (procedure-name path-arg... #!key query-arg...) uri-or-request body-writer body-reader header-reader</syntax>
 
-Generates scheme procedures that call the underlying HTTP API with the parameters given.
+Generates scheme procedures that call the underlying HTTP API with the
+parameters given.
 
-Creates a procedure {{procedure-name}} that calls the HTTP API specified in {{uri-or-request}}. Arguments specified in {{path-arg}} are appended, in the other they appear, to the end of the URI, separated by /. These areguments are mandatory. Arguments specified in {{query-arg}} are optional and, if present are placed in the query string. They are named as they appear in the definition. Their value is that as given when {{procedure-name}} is called.
+Creates a procedure {{procedure-name}} that calls the HTTP API specified in
+{{uri-or-request}}. Arguments specified in {{path-arg}} are appended, in the
+other they appear, to the end of the URI, separated by /. These areguments are
+mandatory. Arguments specified in {{query-arg}} are optional and, if present
+are placed in the query string. They are named as they appear in the
+definition. Their value is that as given when {{procedure-name}} is called.
 
-If body-writer is specified then an extra argument is appended to the {{path-arg}}s and is also mandatory.
+If {{body-writer}} is specified then an extra argument is appended to the
+{{path-arg}}s and is also mandatory.
 
 When the {{procedure-name}} is called, the arguments are put into the URL. If {{body-writer}} is specified then it it is called with the value of the last postitional argument ({{path-arg}}). {{body-writer}} should return something suitable for use as the {{writer}} argument of {{call-with-input-request}}.
 
   POSSIBILITY OF SUCH DAMAGE.
 
 === Version History
-* 0.1, (2012/11/04) : Preliminary support for binding to HTTP REST APIs. We don't currently support the sending of request bodies or the reading of custom response headers.
+* 0.1, (2012/11/04) : Preliminary support for binding to HTTP REST APIs. We
+don't currently support the sending of request bodies or the reading of custom
+response headers.
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.