From 880653f5b55c430a3c1bdeed7873df811f168d6d Mon Sep 17 00:00:00 2001 From: KG Date: Sun, 3 Sep 2023 19:43:21 -0400 Subject: [PATCH] Update settings docs --- tivars/types/settings.py | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/tivars/types/settings.py b/tivars/types/settings.py index 379697a..c937d46 100644 --- a/tivars/types/settings.py +++ b/tivars/types/settings.py @@ -93,7 +93,11 @@ def __init__(self, init=None, *, @Section(8, String) def name(self) -> str: - pass + """ + The name of the entry + + This value is always ``Window``. + """ @Section(min_data_length) def calc_data(self) -> bytes: @@ -274,7 +278,7 @@ def Xres(self, value) -> GraphRealEntry: """ Xres: the pixel separation of points in a function plot - The value must be an integer in [1,8] + The value must be an integer in ``[1,8]``. """ if int(value) != float(value) or not 1 <= int(value) <= 8: @@ -349,7 +353,7 @@ def name(self) -> str: """ The name of the entry - Always equal to RclWindw. + This value is always ``RclWindw``. """ @Section(min_data_length) @@ -531,7 +535,7 @@ def Xres(self, value) -> GraphRealEntry: """ Xres: the pixel separation of points in a function plot - The value must be an integer in [1,8] + The value must be an integer in ``[1,8]``. """ if int(value) != float(value) or not 1 <= int(value) <= 8: @@ -606,7 +610,7 @@ def name(self) -> str: """ The name of the entry - Always equal to TblSet. + This value is always ``TblSet``. """ @Section(min_data_length)