##// END OF EJS Templates
u » pc » rhodecode-enterprise-ce-fork-pc
RSS

Fork of rhodecode-enterprise-ce

nix: Add backwardsCompatibleFetchgit...
nix: Add backwardsCompatibleFetchgit Needed so that we can use fetchgit with the branch nixos-16.03 as well as current nixpkgs-unstable. It restores the behavior of nixos-16.03 which is technically wrong since it removes all .git files. Practically this issue has no big impact, so that we can keep it easily a few months this way until we don't depend on building against nixos-16.03 anymore.
marcink - - Load All Authors

File last commit:

r1:854a839a default
r716:4af5d93c default
Show More
api.rst
60 lines | 1.2 KiB | text/x-rst | RstLexer
/ docs / contributing / api.rst
History | Annotation | Raw |Copy content |Copy permalink

API

Naming conventions

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

Change and Deprecation

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

Deprecated API calls

  • Make sure to add them into the section :ref:`deprecated`.

  • 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.