Update docstring for DiploidPopulation.dump_tables_to_tskit

molpopgen · Jun 2, 2021 · ac23e70 · ac23e70
1 parent 9dfc09f
commit ac23e70
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/fwdpy11/_types/diploid_population.py b/fwdpy11/_types/diploid_population.py
@@ -190,6 +190,15 @@ def dump_tables_to_tskit(
         Dump the population's TableCollection into
         an tskit TreeSequence
 
+        :param model_params: Model parameters to be stored as top-level metadata
+        :type model_params: :class:`fwdpy11.ModelParams` or :class:`dict`
+
+        :param demes_graph: A demographic model specified via `demes`.
+        :type demes_graph: :class:`demes.Graph`
+
+        :param population_metadata: A mapping from integer id of a deme/population to metadata
+        :type population_metadata: dict
+
         :param parameters: The simulation parameters for the provenance table.
         :type parameters: None or dict