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

Add Numerics library to docs #118

Closed
cjsha opened this issue Jan 21, 2025 · 1 comment
Closed

Add Numerics library to docs #118

cjsha opened this issue Jan 21, 2025 · 1 comment

Comments

@cjsha
Copy link

cjsha commented Jan 21, 2025

I spent time searching how to generate random numbers in Bonsai, and I finally came across the Numerics library here. To help people find the Numerics library more quickly and easily, I feel that it would be helpful to point to it as a submodule here. I usually search the Bonsai docs first when I look for something new in Bonsai. I suspect others will try the same when doing random number generation which is probably a common operation in your userbase.

I don't know how y'all decide which packages go in the Bonsai docs though. Maybe it's not fully documented in the XML comments or something.

@banchan86
Copy link
Contributor

banchan86 commented Jan 21, 2025

Hey @cjsha!

So if I am not wrong, the current plan is to have documentation built in the package repository, but to have API/Reference docs pulled together for core packages at some point. They initially had everything together, but if I remember correctly there was a problem with the xrefmap being too large or slow to download. That seems to have been resolved but if we import everything as submodules I think there's also the issue with documentation building slowly. You did raise a good point too that there are missing XML doc comments for that package, so I think those need to be fixed as well before bringing them in. I have raised bonsai-rx/numerics#9 for the docfx website and bonsai-rx/numerics#10 for the XML doc comments.

edit: ah I found the DCM notes where this was discussed!
edit: also this PR referencing this as planned, as such I am closing this specific issue in favor of opening a general issue.

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

No branches or pull requests

2 participants