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

Bonsai.Editor.Scripting operators are missing from technical reference #126

Open
banchan86 opened this issue Feb 11, 2025 · 2 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@banchan86
Copy link
Contributor

banchan86 commented Feb 11, 2025

While adding reference-style links to the tutorials, I noticed that the Bonsai.Editor.Scripting operators (for instance, CSharpTransform) are missing from the Reference section. Not sure if this is by design, or if it's even necessary to add them to the Reference, but just thought I would make a note of it.

@banchan86 banchan86 added the bug Something isn't working label Feb 11, 2025
@glopesdev
Copy link
Member

@banchan86 this is by design in the sense that these are not real operators, but rather placeholders from which c# scripted operators are generated.

These nodes are internal to the editor and can never actually be saved to a workflow or operated in any way other than double clicking them to initialise the script.

I can see how they might be useful to document though. In this case it might be better to simply write an explicit article for them which explains the rules for script generation (or enhance the extending Bonsai article).

@banchan86 banchan86 added documentation Improvements or additions to documentation and removed bug Something isn't working labels Feb 11, 2025
@banchan86
Copy link
Contributor Author

Ah I see! I actually think there is already quite good documentation in the form of the scripting expressions article and scripting tutorial (but I will look into expanding it with what you said).

I was more thinking about what the View Help button in the context menu for those buttons would bring up and how to xref them in documentation. I was wondering if simply assigning a uid to the current scripting expressions article would work, but I realized we would need different markdown snippets and different uids for the different operators.

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

No branches or pull requests

2 participants