##// END OF EJS Templates
rhodecode-enterprise-ce
RSS
admin: fixed problems with generating last change in admin panels....
admin: fixed problems with generating last change in admin panels. - from now on also updated_on will refer as last commit change instead of last update of DB. Reason for that is since we have audit logs the last db update should be taken from there along the change info. Storing last commit date in the dedicated field makes it searchable, sortable and faster to read.
marcink - - Load All Authors

File last commit:

r2205:dd780472 default
r4000:52837660 default
Show More
api.rst
58 lines | 1.2 KiB | text/x-rst | RstLexer
/ docs / contributing / api.rst
History | Annotation | Raw |Copy content |Copy permalink

CONTRIBUTING TO API

Naming conventions

We keep the calls in the form {verb}_{noun}.

Change and Deprecation

API deprecation is documented in the section deprecated together with other notes about deprecated parts of the application.

Deprecated API calls

  • Use deprecated inside of the call docstring to make our users aware of the deprecation:

    .. deprecated:: 1.2.3

   Use `new_call_name` instead to fetch this information.

  • Make sure to log on level logging.WARNING a message that the API call or specific parameters are deprecated.

  • If possible return deprecation information inside of the result from the API call. Use the attribute _warning_ to contain a message.

Changed API calls

  • If the change is significant, consider to use versionchanged in the docstring:

    .. versionchanged:: 1.2.3

   Optional explanation if reasonable.

Added API calls

  • Use versionadded to document since which version this API call is available:

    .. versionadded:: 1.2.3

   Optional explanation if reasonable.