Copy examples into created stubs

[lars-reimann]

Is your feature request related to a problem?

Our API reference in the DSL documentation would benefit from some examples.

Desired solution

Copy the examples from Python docstrings over:

class Column:
    @property
    def name(self) -> str:
        """
        Return the name of the column.

        Returns
        -------
        name : str
            The name of the column.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("test", [1, 2, 3])
        >>> column.name
        'test'
        """
        return self._name

• Keep only the code that starts with >>>.
• Remove the leading >>>.
• Remove a single space from each line, if all lines start with at least one space.
• Remove any blank lines.

Here, you would end up with the following example code:

from safeds.data.tabular.containers import Column
column = Column("test", [1, 2, 3])
column.name

Paste this into the documentation comments of the generate stub, but comment it out. Wrap it into a pipeline:

class Column
/*
 * ...
 * 
 * @example
 * pipeline example {
 *     // from safeds.data.tabular.containers import Column
 *     // column = Column("test", [1, 2, 3])
 *     // column.name
 * }
 */

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response

[lars-reimann]

🎉 This issue has been resolved in version 0.3.0 🎉

The release is available on:

• v0.3.0
• GitHub release

Your semantic-release bot 📦🚀