Skip to content

Commit 6e878f9

Browse files
authored
Fixed a typo in the How-Do-I documentation page and added some information for completion/consistence purposes. (#3534)
1 parent 3b1cd44 commit 6e878f9

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

docs/dev/how-do-i/how-do-i.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,17 +96,17 @@ Get the value of an argument
9696
----------------------------
9797

9898
Relevant functions include:
99-
- ``hoc_obj_getarg(n)``
99+
- ``hoc_objgetarg(n)`` -- returns a ``Object**``
100100

101101
May want to combine this with ``nrnpy_ho2po`` if you know the argument is a ``PyObject``; e.g.
102102

103103
.. code-block:: c
104104
105105
PyObject* obj = nrnpy_ho2po(*hoc_objgetarg(n))
106106
107-
- ``vector_arg(n)`` -- returns a ``Vect*``
107+
- ``vector_arg(n)`` -- returns a ``IvocVect*``
108108
- ``hoc_pgetarg(n)`` -- returns a ``double**``
109-
- ``gargstr(n)``
109+
- ``gargstr(n)`` -- returns a ``char*``
110110
- ``getarg(n)`` -- returns a ``double*``. Python bools, ints, and floats are all valid inputs.
111111

112112
Note: attempting to get the wrong type of an argument displays a "bad stack access" message and

0 commit comments

Comments
 (0)