search

open-ephys / bonsai-onix1-docs

Documentation for the OpenEphys.Onix1 Bonsai package
https://open-ephys.github.io/bonsai-onix1-docs/
Creative Commons Attribution Share Alike 4.0 International
0 stars 2 forks source link

Show top-level enum summary and remarks on operator pages? #20

Closed cjsha closed 3 months ago

cjsha commented 3 months ago

Screenshot 2024-08-09 164735

The top-level summary and remarks for enums (underlined in red in the above screenshot) don't show up when enums are integrated into the page of the operator that utilizes that enum (demonstrated below).

image

I don't really care too much to include it in our template, but I wanted to bring it up as a point of discussion to confirm it's ok not care too much about these particular summary and remarks.

I could integrate it like this:

Screenshot 2024-08-09 165524

@jonnew @bparks13 @ChucklesOnGitHub are all tagged because they might want to voice an opinion here.

bparks13 commented 3 months ago

I think I'm okay leaving it off of the operator page, there is a lot of information to fit in those tables and it's pretty much redundant information anyway.

cjsha commented 3 months ago

I agree with Brandon and since no one else has expressed an opinion, I'm closing this issue.