Skip to content

Add .help to String as a shortcut for HelpBrowser.goTo("address") - #7697

Open
prko wants to merge 2 commits into
supercollider:developfrom
prko:topic/add_Help.goTo_shortcut_to_String.help
Open

prko wants to merge 2 commits into
supercollider:developfrom
prko:topic/add_Help.goTo_shortcut_to_String.help

Conversation

@prko

@prko prko commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Purpose and Motivation

Many Quarks do not provide .schelp files; instead, they include documentation in formats such as .scd, README.md, or HTML.
This PR makes it easier for users to open such documentation directly, for example:

  •  "https://github.com/jmuxfeldt/jostMlib".include
     "https://github.com/jmuxfeldt/jostMlib".help
  •  "https://github.com/smoge/Rastrum".include
     "https://github.com/smoge/Rastrum".help
  • "local/path/to/any/html/file.html".help

SCD files can be accessed via GitHub online.

Types of changes

  • Documentation
  • Bug fix
  • New feature
  • Breaking change

To-do list

  • Code is tested
  • All tests are passing
  • This PR is ready for review

@prko

prko commented Sep 13, 2026

Copy link
Copy Markdown
Contributor Author

Is nobody interested in this PR?

I think this PR makes it easier to access documentation, especially when working with many quarks. It could benefit not only beginners but also developers and advanced users.

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

Successfully merging this pull request may close these issues.

1 participant