Skip to content

Variable

Variable

Bases: BaseModel

Global variable class

Source code in src/task2md/template/variable.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
class Variable(BaseModel):
    """Global variable class"""

    name: str = ""
    value: str = ""
    description: str = ""

    def to_md(self) -> str:
        """Return the details of the variable

        Returns:
            str: Markdown columns of the variable details
        """
        name = " - " if self.name == "" else f"`{self.name}`"
        description = " - " if self.description == "" else self.description
        value = " - " if self.value == "" else f"`{self.value}`"

        return f"| {name} | {description} | {value} |"

to_md()

Return the details of the variable

Returns:

Name Type Description
str str

Markdown columns of the variable details
Source code in src/task2md/template/variable.py 
11
12
13
14
15
16
17
18
19
20
21
def to_md(self) -> str:
    """Return the details of the variable

    Returns:
        str: Markdown columns of the variable details
    """
    name = " - " if self.name == "" else f"`{self.name}`"
    description = " - " if self.description == "" else self.description
    value = " - " if self.value == "" else f"`{self.value}`"

    return f"| {name} | {description} | {value} |"