supercollider icon indicating copy to clipboard operation
supercollider copied to clipboard

SCDoc bug: section and subsection including `"`, `>` or `<` does not produce correct link

Open prko opened this issue 7 months ago • 0 comments

Environment

  • SuperCollider version: 3.14.0-dev
  • Operating system:
  • Other details (Qt version, audio driver, etc.):

Steps to reproduce

  1. TypeUserFAQ in the code editor of SC-IDE
  2. Press cmd/ctrl + d
  3. Click Table of Contents in the HelpBrowser
  4. Select one of the followings:
    • "If" statements inside a SynthDef
    • Why is x > 0 "non-Boolean" in the "test"?

Expected vs. actual behavior

Expected behavior

The HelpBrowser should show the corresponding part in the documents.

Actual behavior

Nothing happens due to " and > in the sectional tag. The following list shows other similar parts in the whole schelp files:

8 results - 6 files

HelpSource/Classes/DiskIn.schelp:
  54  
  55: subsection:: Normal usage (with Buffer; "Object Style")
  56  code::

HelpSource/Classes/ScrollView.schelp:
  163  
  164: SUBSECTION:: "Rulers", using an action function
  165  

HelpSource/Guides/Tour_of_UGens.schelp:
   42  
   43: subsection:: LF - "Low Frequency" Unit Generators.
   44  

  264  
  265: subsection:: LF "Low Frequency" Noise Generators.
  266  

HelpSource/Guides/UserFAQ.schelp:
  113  
  114: subsection:: "If" statements inside a SynthDef
  115  

  143  
  144: subsection:: Why is x > 0 "non-Boolean" in the "test"?
  145  

HelpSource/Reference/Literals.schelp:
  342  
  343: subsection:: What counts as "inside the function"?
  344  

HelpSource/Tutorials/A-Practical-Guide/PG_Cookbook08_Swing.schelp:
  5  
  6: section:: Converting equal divisions into "swing"
  7  

HelpSource/Guides/Randomness.schelp:
  16  
  17: subsection:: Between zero and <number>
  18  code::

  23  
  24: subsection:: Between -<number> and <number>
  25  code::

See also #6278 for a similar issue.

prko avatar Jun 04 '25 16:06 prko