Skip to content
This repository was archived by the owner on Feb 26, 2025. It is now read-only.

Commit c9b9ab1

Browse files
author
Weina Ji
committed
generate docstrings
1 parent 1ad5c92 commit c9b9ab1

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

include/bbp/sonata/config.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ class SONATA_API SimulationConfig
368368
mechanisms;
369369
/// List of modifications that mimics experimental manipulations to the circuit.
370370
std::vector<Modification> modifications;
371-
// Method to return the full list of modifications in the Conditions section
371+
/// Method to return the full list of modifications in the Conditions section.
372372
const std::vector<Modification>& getModifications() const noexcept;
373373
};
374374
/**

python/generated/docstrings.h

+7-9
Original file line numberDiff line numberDiff line change
@@ -713,22 +713,18 @@ R"doc(Extracellular calcium concentration, being applied to the synapse
713713
uHill parameter in order to scale the U parameter of synapses. Default
714714
is None.)doc";
715715

716-
static const char *__doc_bbp_sonata_SimulationConfig_Conditions_getModification =
717-
R"doc(Returns the given modification parameters
718-
719-
Throws:
720-
SonataError if the given modification name does not exist)doc";
721-
722-
static const char *__doc_bbp_sonata_SimulationConfig_Conditions_listModificationNames = R"doc(Returns the names of the modifications)doc";
716+
static const char *__doc_bbp_sonata_SimulationConfig_Conditions_getModifications =
717+
R"doc(Method to return the full list of modifications in the Conditions
718+
section.)doc";
723719

724720
static const char *__doc_bbp_sonata_SimulationConfig_Conditions_mechanisms =
725721
R"doc(Properties to assign values to variables in synapse MOD files. The
726722
format is a dictionary with keys being the SUFFIX names and values
727723
being dictionaries of variables' names and values.)doc";
728724

729725
static const char *__doc_bbp_sonata_SimulationConfig_Conditions_modifications =
730-
R"doc(Collection of dictionaries with each member decribing a modification
731-
that mimics experimental manipulations to the circuit.)doc";
726+
R"doc(List of modifications that mimics experimental manipulations to the
727+
circuit.)doc";
732728

733729
static const char *__doc_bbp_sonata_SimulationConfig_Conditions_randomizeGabaRiseTime =
734730
R"doc(Enable legacy behavior to randomize the GABA_A rise time in the helper
@@ -1022,6 +1018,8 @@ static const char *__doc_bbp_sonata_SimulationConfig_ModificationBase_Modificati
10221018

10231019
static const char *__doc_bbp_sonata_SimulationConfig_ModificationBase_ModificationType_invalid = R"doc()doc";
10241020

1021+
static const char *__doc_bbp_sonata_SimulationConfig_ModificationBase_name = R"doc(Name of the modification setting.)doc";
1022+
10251023
static const char *__doc_bbp_sonata_SimulationConfig_ModificationBase_nodeSet = R"doc(Node set which receives the manipulation)doc";
10261024

10271025
static const char *__doc_bbp_sonata_SimulationConfig_ModificationBase_type =

0 commit comments

Comments
 (0)