From 61c1dc871710d3da260ddeb28bb0218a86d02aff Mon Sep 17 00:00:00 2001 From: Zihao Xu Date: Tue, 14 Nov 2023 03:23:50 +0800 Subject: [PATCH] refine the docstr --- appletree/config.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/appletree/config.py b/appletree/config.py index c49365cb..8b155c1f 100644 --- a/appletree/config.py +++ b/appletree/config.py @@ -280,11 +280,12 @@ def pdf_to_cdf(self, x, pdf): class SigmaMap(Config): """Maps with uncertainty. - Default value is a list whose order is: - [median, lower, upper, (parameter)] - Each map is assigned as attribute of SigmaMap. - If the last element in the list is the required parameter. + The value of a SigmaMap can be: + * a list with four elements, which are the file names of median, lower, upper maps and the name of the scaler. + * a list with three elements, which are the file names of median, lower and upper maps. The name of the scaler is the default one f"{self.name}_sigma". + * a string, which is the file name of the median map. + In the first and second case, the name of the scaler will appear in component.needed_parameters. """ def build(self, llh_name: Optional[str] = None):