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

Reorder/refactor kernels and solvers to match documentation order #754

Open
tp832944 opened this issue Aug 28, 2024 · 0 comments · May be fixed by #759
Open

Reorder/refactor kernels and solvers to match documentation order #754

tp832944 opened this issue Aug 28, 2024 · 0 comments · May be fixed by #759
Assignees
@db091756

Comments

@tp832944
Copy link
Contributor

What's the issue?

It is difficult for developers to browse code when the documentation order does not match the code order. @db091756 has a good idea for the documentation order. The code should be reordered to match this.

Some modules are getting rather large so this may be a good time to split into multiple submodules.

Note: the documentation order is specified by __all__ in __init__.py.
@tp832944 tp832944 added new Something yet to be discussed by development team and removed new Something yet to be discussed by development team labels Aug 28, 2024
@db091756 db091756 self-assigned this Aug 30, 2024
@db091756 db091756 linked a pull request Aug 30, 2024 that will close this issue
docs: reordered docs for solvers and kernels #759
Open
9 tasks
@pc532627 pc532627 mentioned this issue Sep 17, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@db091756 db091756

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: reordered docs for solvers and kernels gchq/coreax
2 participants
@tp832944 @db091756