Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rethink async/isgenerator and alike. #301

Open
Carreau opened this issue Oct 2, 2023 · 3 comments
Open

Rethink async/isgenerator and alike. #301

Carreau opened this issue Oct 2, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@Carreau
Copy link
Member

Carreau commented Oct 2, 2023

right now, we store a kind to tell us wether something is builtins, generator...

https://github.com/jupyter/papyri/blob/45c158d0e8011fe0bb23e6a5eb4a4b6e4e521245/papyri/signature.py#L90-L99C13

I'm not sure this is the best way as a builtin can be a coroutine function ... etc. It might be a good idea to rethink what we should store and how.
@melissawm melissawm added the enhancement New feature or request label Oct 26, 2023
@Carreau
Copy link
Member Author

Carreau commented Nov 2, 2023

Expanding a bit on this, to both try to get things out of my head, and take the habit of making longer description.

Some of this information is likely necessary for rendering (like do you show def vs async def), but can be used for other things, like there is a search field, we could have a is:generator filter for example, or warn that there is no Yield section in the docs.

In general we should try to keep information when we can, so that the frontend can decide what an how to render it.

@melissawm
Copy link
Collaborator

Do we have any cases of this? I could only find examples of "functions" throughout all the toml examples and the tests.

@Carreau
Copy link
Member Author

Carreau commented Nov 3, 2023

In papyri itself, I don't think there are any in the tests. We should add those.

@melissawm melissawm mentioned this issue Nov 11, 2023
Merged
Carreau added a commit that referenced this issue Nov 15, 2023
@Carreau
Change object inspection logic (#323)
dcc330c 
Also adds a test for a generator function.

Previously, different kinds of functions were not detected as the
"function" condition was short-circuiting the cases. This is a first
pass for allowing more details in this metadata.

Addresses (but doesn't close) #301
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Carreau @melissawm