chmarti1 / PYroMat

PYroMat thermodynamic properties in Python
http://pyromat.org
Other
66 stars 13 forks source link

Provide typing #91

Open tmoulignier opened 1 month ago

tmoulignier commented 1 month ago

Hello,

Is it possible to provide typing in classes properties and functions? for example:

def get( idstr): becomes:

from .registry.ig import ig
def get( idstr:str ) -> ig:

That way, people using IDE can crawl from a function to another, and have auto-completion working.

The documentation also does not display properly in markdown (in VScode at least) as we would require two line break (or add an \n at the end of the line). image

Thanks