From b2f117e0b22001eb9c0db2795d8e7ef4994d6eb3 Mon Sep 17 00:00:00 2001
From: MoritzThomasHuebner <email@moritz-huebner.de>
Date: Thu, 18 Mar 2021 17:41:16 +1100
Subject: [PATCH] Fixed some documentation
---
bilby/core/result.py | 6 +++---
bilby/core/sampler/__init__.py | 2 +-
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/bilby/core/result.py b/bilby/core/result.py
index 789fa5d9e..7e25a9fda 100644
--- a/bilby/core/result.py
+++ b/bilby/core/result.py
@@ -42,7 +42,7 @@ def result_file_name(outdir, label, extension='json', gzip=False):
label: str
Naming scheme of the output file
extension: str, optional
- Whether to save as `hdf5` or `json`
+ Whether to save as `hdf5`, `json`, or `pickle`
gzip: bool, optional
Set to True to append `.gz` to the extension for saving in gzipped format
@@ -730,11 +730,11 @@ class Result(object):
default=False
outdir: str, optional
Path to the outdir. Default is the one stored in the result object.
- extension: str, optional {json, hdf5, True}
+ extension: str, optional {json, hdf5, pickle, True}
Determines the method to use to store the data (if True defaults
to json)
gzip: bool, optional
- If true, and outputing to a json file, this will gzip the resulting
+ If true, and outputting to a json file, this will gzip the resulting
file and add '.gz' to the file extension.
"""
diff --git a/bilby/core/sampler/__init__.py b/bilby/core/sampler/__init__.py
index 0b81c26b3..1334ac0ac 100644
--- a/bilby/core/sampler/__init__.py
+++ b/bilby/core/sampler/__init__.py
@@ -93,7 +93,7 @@ def run_sampler(likelihood, priors=None, label='label', outdir='outdir',
saving. For example, if `meta_data={dtype: 'signal'}`. Warning: in case
of conflict with keys saved by bilby, the meta_data keys will be
overwritten.
- save: bool
+ save: bool, str
If true, save the priors and results to disk.
If hdf5, save as an hdf5 file instead of json.
If pickle or pkl, save as an pickle file instead of json.
--
GitLab