Skip to content

Support doc strings which are specified below the property definition #105

@VigneshVSV

Description

@VigneshVSV

A feature in the newer versions of python which work well with code editors - it is possible to specify docs or description right below to the definition, similar to function or method docstring.

Syntax:

class MyThing(Thing):

    my_prop = Property(default=5)
    """this is the doc string""" 

    # compared to existing specification
    my_prop2 = Property(default=5, doc="this is the docstring")

Pick up this syntax and fit into the value of doc of the Property.

Rough steps:

  • inspect the definition annotation to see where this value is set
  • populate said value into the doc variable of property
  • verify if code editors pick up, if not, still support the above two steps, lets see what to do later.

Once the doc is set, its automatically picked up the TD/TM generator.

Metadata

Metadata

Assignees

No one assigned

    Labels

    beginnerbeginner level good first issues, usually issues that can worked on without skimming the whole repogood first issueGood for newcomers

    Projects

    Status

    Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions