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

Fix a bug in the help document: SCDoc shows correct position when clicking on generic method name in TOC #6280

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

prko
Copy link
Contributor

@prko prko commented Apr 30, 2024

A demo video of the fix of this PR:
https://www.dropbox.com/scl/fi/0t7kl9x6f5npp1qcnintr/resolved-the-problem-of-Operators-help-document.mov?rlkey=8z3av3cfzacwmmgw377rm3atv&dl=0

Purpose and Motivation

This fixes the problem described in the following scsynth forum post:
https://scsynth.org/t/scdoc-links-to-named-anchors-seem-not-to-be-working/4380/8

A demo video of the problem:
https://www.dropbox.com/scl/fi/1j70bx7qf0fschsj1bln7/problem-of-Operators-help-document.mov?rlkey=vkdvuj4w33h6z1l80zort9gdo&dl=0

Types of changes

  • Bug fix

To-do list

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

fix genericMethod render bug
@prko prko changed the title Bug fixed: Clicking on a generic method name in the TOC now works! Help document bug fixed: Clicking on a generic method name in the TOC now works! Apr 30, 2024
@prko
Copy link
Contributor Author

prko commented May 1, 2024

@prko prko changed the title Help document bug fixed: Clicking on a generic method name in the TOC now works! Fix a bug in the help document: SCDoc shows correct position when clicking on generic method name in TOC May 4, 2024
@JordanHendersonMusic JordanHendersonMusic added the comp: SCDoc scdoc syntax, parser, and renderer. for changes to schelp files, use "comp: help" label May 7, 2024
Copy link
Contributor

@capital-G capital-G left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't checked it myself yet, but the video makes it plausible - interesting that it's not a JS bug.
The current non-working state can be verified here https://dev.docs.supercollider.online/Overviews/Operators.html

Every time we change the HTML renderer, we need to bump the internal version counter - since there are a lot of HTML renderer PRs currently, we should wait for a good time to merge this PR with a PR that bumps the doc version - otherwise we will have merge conflicts if every PR tries to bump the version.

Is this ok with your @prko?

@capital-G capital-G added the has merge note The Conversation has a note concerning how/when this PR is merged label May 28, 2024
@prko
Copy link
Contributor Author

prko commented May 28, 2024

@capital-G
Of course, it is no problem! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp: SCDoc scdoc syntax, parser, and renderer. for changes to schelp files, use "comp: help" has merge note The Conversation has a note concerning how/when this PR is merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants