gchq / gchq/coreax

Equinox integer field compiled into docs as `Any`

Open
#736 0 comments 0 reactions 1 assignee Claimed by @tm91236 View on GitHub
bug documentation
Dominant language
Python
Stars
43
Forks
6
Avg merge
3d 22h
Merged PRs (30d)
10

Description

### 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_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.