From df95157908b36e6304c325ad20160eb309687342 Mon Sep 17 00:00:00 2001
From: Brent Huisman <brenthuisman@users.noreply.github.com>
Date: Thu, 24 Jun 2021 17:08:23 +0200
Subject: [PATCH] `arbor.mechanism_catalogue.extend()` documentation added.
(#1597)
---
doc/python/mechanisms.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/doc/python/mechanisms.rst b/doc/python/mechanisms.rst
index 8617021e..54c6a32e 100644
--- a/doc/python/mechanisms.rst
+++ b/doc/python/mechanisms.rst
@@ -305,6 +305,23 @@ Mechanism catalogues
:return: :class:`py_mech_cat_iterator`
+
+ .. py:method:: extend(other, prefix)
+
+ Import another catalogue, possibly with a prefix. Will overwrite in case of name collisions.
+
+ .. code-block:: Python
+
+ import arbor
+
+ cat = arbor.default_catalogue()
+ cat.extend(arbor.allen_catalogue(), "")
+
+ :param other: reference to other catalogue.
+ :type other: :class:`mechanism_catalogue`
+ :param prefix: prefix for mechanism names in ``other``
+ :type prefix: str
+
.. py:method:: derive(name, parent, globals={}, ions={})
Derive a new mechanism with *name* from the mechanism *parent*.
--
GitLab