diff --git a/doc/source/api/guidelines.rst b/doc/source/api/guidelines.rst index e97d46b8595..b019c916037 100644 --- a/doc/source/api/guidelines.rst +++ b/doc/source/api/guidelines.rst @@ -8,7 +8,7 @@ these guidelines - but developers contributing to the Galaxy API SHOULD follow these guidelines. - API functionality should include docstring documentation for consumption - by readthedocs.org. + at docs.galaxyproject.org. - Developers should familiarize themselves with the HTTP status code definitions http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. The API responses should properly set the status code according to the result - in particular @@ -50,12 +50,10 @@ consider them when modifying the API. that into Mixins (http://en.wikipedia.org/wiki/Composition_over_inheritance) or into Managers (:doc:`galaxy.managers`). - API additions are more permanent changes to Galaxy than many other potential - changes and so a second opinion on API changes should be sought. (Consider a - pull request!) + changes and so a second opinion on API changes should be sought. - New API functionality should include functional tests. These functional tests should be implemented in Python and placed in - `test/functional/api`. (Once such a framework is in place - it is not - right now). + `test/functional/api`. - Changes to reflect modifications to the API should be pushed upstream to the BioBlend project if possible.