You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The repeated Clock, Clock issue in the above comment comes from the fact that the class name is being striped form the type. This what it looks like inside VS:
<see cref="BufferedDataFrame.Clock"/> is rendered into the data model by docfx as: <xref href="OpenEphys.Onix1.BufferedDataFrame.Clock" data-throw-if-not-resolved="false"></xref>
which is subsequently converted to html as: <a class="xref" href="OpenEphys.Onix1.BufferedDataFrame.html">Clock</a>
I know the ideal solution is to not make any edits to the comments and somehow just keep the class name, so I made an issue for this in the docs repo. This is a more long-term issue though because I'm not immediately sure how to hook into the <xref> => <a> conversion build step.
The workaround for this in the meanwhile would be to explicitly state what text you want to be in there by wrapping it in tags:
The top-level summary and remarks of ContextTask is a bit jargony. Additional description, external links, or dumbing-down might help.
oni.Context
oroni.Frame
don't seem to be valid cref values.https://github.com/open-ephys/onix-bonsai-onix1/blob/7ac700fb8a696d4d9f8d97c9d1b85765b9951ca6/OpenEphys.Onix1/ContextTask.cs#L12-L20
Don't repeat Clock as an example for the oni.Frame.Clock and its derivatives.
https://github.com/open-ephys/onix-bonsai-onix1/blob/7ac700fb8a696d4d9f8d97c9d1b85765b9951ca6/OpenEphys.Onix1/ContextTask.cs#L121-L125
The text was updated successfully, but these errors were encountered: