Commits

Timothy Corbett-Clark committed 5d5aaad Draft

Edited online

Comments (0)

Files changed (1)

ApiDocumentation.wiki

 ** The examples are generated by running against the real server, thus automatically ensure accuracy
 * Redirect HTTP GET for {{{text/html}}} to the appropriate page
 
-See [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/apidocs|apidocs]] for details.
+See [[https://bitbucket.org/tcorbettclark/rest-api-blueprint/src/tip/apidocs|apidocs]] for details. Beware that:
+* Bitbucket does not understand all the directives, so browse the {{{.rst}}} files in raw mode.
+* The command-output plugin used to generate up to date examples caches the output from commands and so only runs them once. The key to the cache is the command itself...