- 
          
 - 
                Notifications
    
You must be signed in to change notification settings  - Fork 7
 
Open
Labels
beginnerbeginner level good first issues, usually issues that can worked on without skimming the whole repobeginner level good first issues, usually issues that can worked on without skimming the whole repogood first issueGood for newcomersGood for newcomers
Description
A feature that I came across which work well with code editors - it is possible to specify docs or description right below the definition of properties or class attributes, similar to function or method docstring. Somehow, this was not known while creating the docstring attribute.
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 
docvariable 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
Labels
beginnerbeginner level good first issues, usually issues that can worked on without skimming the whole repobeginner level good first issues, usually issues that can worked on without skimming the whole repogood first issueGood for newcomersGood for newcomers
Type
Projects
Status
Ready