Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Reverting `UndefinedLike`?

See original GitHub issue

In https://github.com/altair-viz/altair/pull/2681, we have merged the pull request that

UndefinedLike = Any
Undefined: UndefinedLike = UndefinedType()

But the result now is that the docsctrings looks like this:

I do not think we favor this behavior. Maybe https://github.com/altair-viz/altair/pull/2670 was sufficient already?

Undefined: Any = UndefinedType()

Or will this make the docstrings look like: data: Undefined = Any, encoding: Undefined = Any, etc?

Issue Analytics

State:
Created 10 months ago
Comments:11 (3 by maintainers)

Top GitHub Comments

1reaction

mattijncommented, Nov 17, 2022

Thanks again for the comments here! Let’s hope to have proper type support in the future.

Moreover, if people have a strong knowledgeable opinion on this, #2614 is a good place to discuss this further.

0reactions

joelostblomcommented, Nov 16, 2022

@brahn I was referring to A and I meant modifying the function signature, not the docstring as I wrote initially, sorry about the confusion caused.

@mattijn Nice job digging that up. I agree with you that a solution to fix the issues for now that we can later iterate on if we want to improve the docstring styling is a good idea.

Also, is this only an issue in Google Collab? I just had a look in JupyterLab with the latest master and the docstrings look great, very readable with one parameter per line. I don’t see the typehints though so maybe jupyterlab does not support that yet?