Missing type annotation for maturin project

[benruijl]

I am building a Python module from Rust using maturin. To include type information, I provide a .pyi file. The type information is properly handled when using Visual Studio Code for example, but when I try to generate docs with quartodoc I do not see any types for my function arguments and return values.

[machow]

It looks like griffe (which we use to look up type hints) supports .pyi files, so should find this information. I haven't tried looking up this kind of info yet, though, and will add a type stub to quartodoc to check!

mkdocstrings/griffe#77

[machow]

I've added a test that uses a stub file, and was able to see the type annotations in the stub. Do you mind checking whether the latest version of quartodoc, and upgrading griffe, find the annotations.

Here's the PR with the test:

• tests: get_object returns annotations from pyi stub files #360

[benruijl]

I upgraded everything and I still don't see the annotations rendered. But maybe I misunderstand what the output should give?
Here is a screenshot:

For the function parse I added an explicit Parameters block and it shows the type that I provided in that block. For the function num, I didn't provide a block.

Both functions do not show any types. I would have expected:

Expression.num(_cls, num: float | int, relative_error:float =None)
Expression.parse(_cls, input: str)

[machow]

Ah, it sounds like you're saying the types aren't showing up in the call signature. Is that right? I don't think that's currently implemented, but is definitely worth enabling.

If that sounds right, I can use this issue to track implementing annotations in call signatures

[benruijl]

Where would the type annotations currently be displayed? I believe the type in the Parameters block is parsed from the docstring? I haven't tried what happens if I omit the types in the docstring.

I would indeed love to see type annotations in the call signatures. You can reuse this issue, but you/I could also start a new one.

[machow]

If you omit the type in the Parameters section, it should fill it in based on the signature.

For example, something like...

def f(x: int):
    """A function.
    
    Parameters
    ------------
    x:
        The x parameter

    """

Should fill in that x is an int, based on the signature