Skip to content

Commit

Permalink
docs(nml): improve cell helper method docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
sanjayankur31 committed Dec 20, 2023
1 parent 71c6924 commit ee93b33
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions neuroml/nml/helper_methods.py
Original file line number Diff line number Diff line change
Expand Up @@ -1867,8 +1867,8 @@ def add_membrane_property(self, property_name, **kwargs):
Please also see specific functions in this module, which are designed to be
easier to use than this generic function.
:param property_name: name of membrane to add
:type property_name: str
:param property_name: name or class of membrane property to add
:type property_name: str or class
:param kwargs: named arguments for membrane property to be added
:type kwargs: Any
:returns: added property
Expand All @@ -1888,10 +1888,10 @@ def add_channel_density_v(
):
"""Generic function to add channel density components to a Cell.
:param channel_density_type: type of channel density to add.
:param channel_density_type: name or class of channel density type to add.
See https://docs.neuroml.org/Userdocs/Schemas/Cells.html for the
complete list.
:type channel_density_type: str
:type channel_density_type: str or class
:param nml_cell_doc: cell NeuroML document to which channel density is to be added
:type nml_cell_doc: NeuroMLDocument
:param ion_chan_def_file: path to NeuroML2 file defining the ion channel, if empty, it assumes the channel is defined in the same file
Expand Down
12 changes: 6 additions & 6 deletions neuroml/nml/nml.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# -*- coding: utf-8 -*-

#
# Generated Tue Dec 5 10:44:41 2023 by generateDS.py version 2.43.3.
# Python 3.11.6 (main, Oct 3 2023, 00:00:00) [GCC 13.2.1 20230918 (Red Hat 13.2.1-3)]
# Generated Wed Dec 20 14:57:27 2023 by generateDS.py version 2.43.3.
# Python 3.11.7 (main, Dec 6 2023, 00:00:00) [GCC 13.2.1 20231205 (Red Hat 13.2.1-6)]
#
# Command line options:
# ('-o', 'nml.py')
Expand Down Expand Up @@ -49430,8 +49430,8 @@ def add_membrane_property(self, property_name, **kwargs):
Please also see specific functions in this module, which are designed to be
easier to use than this generic function.

:param property_name: name of membrane to add
:type property_name: str
:param property_name: name or class of membrane property to add
:type property_name: str or class
:param kwargs: named arguments for membrane property to be added
:type kwargs: Any
:returns: added property
Expand All @@ -49448,10 +49448,10 @@ def add_channel_density_v(
):
"""Generic function to add channel density components to a Cell.

:param channel_density_type: type of channel density to add.
:param channel_density_type: name or class of channel density type to add.
See https://docs.neuroml.org/Userdocs/Schemas/Cells.html for the
complete list.
:type channel_density_type: str
:type channel_density_type: str or class
:param nml_cell_doc: cell NeuroML document to which channel density is to be added
:type nml_cell_doc: NeuroMLDocument
:param ion_chan_def_file: path to NeuroML2 file defining the ion channel, if empty, it assumes the channel is defined in the same file
Expand Down

0 comments on commit ee93b33

Please sign in to comment.