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

Equinox integer field compiled into docs as Any #736

Open
tp832944 opened this issue Aug 15, 2024 · 0 comments
Open

Equinox integer field compiled into docs as Any #736

tp832944 opened this issue Aug 15, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@tp832944
Copy link
Contributor

What's the problem?

coreax.solvers.ExplicitSizeSolver.coreset_size type renders in the compiled documentation as Any. It should be either an Equinox field of type int, or perhaps clearer as just int.

A possible solution might be to expand the functionality of typehints_formatter in documentation/source/conf.py.

How can we reproduce the issue?

View documentation.

Python version

3.12

Package version

0.2.1

Operating system

Windows

Other packages

No response

Relevant log output

No response
@tp832944 tp832944 added bug Something isn't working new Something yet to be discussed by development team documentation Improvements or additions to documentation and removed new Something yet to be discussed by development team labels Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tp832944