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.

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

All functions with @solara.component annotation missing on read the docs #2451

Open
quaquel opened this issue Nov 2, 2024 · 3 comments
Open
Labels
bug Release notes label docs Release notes label

Comments

@quaquel
Copy link
Member

quaquel commented Nov 2, 2024

Something weird is going on: all functions annotated with @solara.component are not included in the read-the-docs API overview. I have checked the error log on RTD (we need to some cleaning...., but that's a seperate issue). I can't find anything related to this. No idea what is going on.

@quaquel quaquel added docs Release notes label bug Release notes label labels Nov 2, 2024
@EwoutH
Copy link
Member

EwoutH commented Nov 2, 2024

Strange. @maartenbreddels, if I may ask, have you encountered this earlier by any chance?

@maartenbreddels
Copy link

No, that's strange indeed.
Looking at this example it seems that the docstring is passed 'up' to the decorator.

@quaquel
Copy link
Member Author

quaquel commented Nov 2, 2024

My hunch is that the wrapper in solara.component should itself be annoted with functools.wraps to solve this problem. According to the docs "Without the use of this decorator factory, the name of the example function would have been 'wrapper', and the docstring of the original example() would have been lost."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Release notes label docs Release notes label
Projects
None yet
Development

No branches or pull requests

3 participants