Skip to content

Utilize types in the Python docs #2959

Open
@lukicdarkoo

Description

@lukicdarkoo

Maybe, the Python documentation would be more readable by utilizing the Python typing. For example, instead of:

from controller import Node

class Node:
    def getId(self):
    def getDef(self):
    def getParentNode(self):
    def isProto(self):
    def getFromProtoDef(self, name):

we could write

from controller import Node

class Node:
    def getId(self) -> int:
    def getDef(self) -> str:
    def getParentNode(self) -> Node:
    def isProto(self) -> bool:
    def getFromProtoDef(self, name : str):

The same applies to the implementation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprove or fix the documentation (MD files only, no software development)good first issueCould be addressed by a newbee contributor

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions