diff --git a/paramecio2/libraries/db/extraforms/checkform.py b/paramecio2/libraries/db/extraforms/checkform.py index 7ad8d8d..943ae34 100644 --- a/paramecio2/libraries/db/extraforms/checkform.py +++ b/paramecio2/libraries/db/extraforms/checkform.py @@ -3,8 +3,16 @@ from paramecio2.libraries.db.coreforms import BaseForm class CheckForm(BaseForm): + """Checkbox form, used normally with boolean fields""" def __init__(self, name, value, real_value=1): + """ + Args: + name (str): The html name for this form + value (str): The default value of this html form. + real_value (str): Variable used for construct the html form, by default 1. + """ + super(CheckForm, self).__init__(name, value) self.real_value=real_value diff --git a/paramecio2/libraries/db/extraforms/colorform.py b/paramecio2/libraries/db/extraforms/colorform.py index 0cbce1b..4b6b62b 100644 --- a/paramecio2/libraries/db/extraforms/colorform.py +++ b/paramecio2/libraries/db/extraforms/colorform.py @@ -4,6 +4,7 @@ from paramecio2.libraries.db.coreforms import BaseForm from paramecio2.libraries.mtemplates import standard_t class ColorForm(BaseForm): + """Form for get colors from a picker""" def __init__(self, name, value): diff --git a/paramecio2/libraries/db/extraforms/dateform.py b/paramecio2/libraries/db/extraforms/dateform.py index 05da7fe..c888c6f 100644 --- a/paramecio2/libraries/db/extraforms/dateform.py +++ b/paramecio2/libraries/db/extraforms/dateform.py @@ -5,6 +5,7 @@ from paramecio2.libraries.mtemplates import standard_t from paramecio2.libraries.datetime import format_timedata class DateForm(BaseForm): + """Create a form for dates, with year, day, hour, minut and seconds""" def __init__(self, name, value): diff --git a/paramecio2/libraries/db/extraforms/fileform.py b/paramecio2/libraries/db/extraforms/fileform.py index 65422ec..ba64248 100644 --- a/paramecio2/libraries/db/extraforms/fileform.py +++ b/paramecio2/libraries/db/extraforms/fileform.py @@ -8,8 +8,15 @@ env=env_theme(__file__) t=PTemplate(env) class FileForm(BaseForm): + """Class for create a form for upload files. You shoud set enctype to True in your model for it""" def __init__(self, name, value, path): + """ + Args: + name (str): The html name for this form + value (str): The default value of this html form. + path (str): The path where the file will be saved. + """ super().__init__(name, value) diff --git a/paramecio2/libraries/db/extraforms/i18nform.py b/paramecio2/libraries/db/extraforms/i18nform.py index fc18efc..410f103 100644 --- a/paramecio2/libraries/db/extraforms/i18nform.py +++ b/paramecio2/libraries/db/extraforms/i18nform.py @@ -6,8 +6,15 @@ from paramecio2.libraries.mtemplates import standard_t import json class I18nForm(BaseForm): + """Form for data with multiple languages.""" def __init__(self, name, value, form): + """ + Args: + name (str): The html name for this form + value (str): The default value of this html form. + form (BaseForm): The form used for generate the multiple languade form. Example if you use a TextForm, a TextForm for every language will be showed. + """ super().__init__(name, value) diff --git a/paramecio2/libraries/db/extraforms/texthtmlform.py b/paramecio2/libraries/db/extraforms/texthtmlform.py index ffcef75..6ba9d73 100644 --- a/paramecio2/libraries/db/extraforms/texthtmlform.py +++ b/paramecio2/libraries/db/extraforms/texthtmlform.py @@ -7,8 +7,15 @@ env=env_theme(__file__) t=PTemplate(env) class TextHTMLForm(BaseForm): + """Form for html texts, based in tinycme javascript library""" def __init__(self, name, value, t_add=None): + """ + Args: + name (str): The html name for this form + value (str): The default value of this html form. + t_add (PTemplate): If you want change the standard html form, use other template loader + """ super().__init__(name, value)