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

update references to engine.scratch.. functions #704

Open
wants to merge 1 commit into
base: 2.4
Choose a base branch
from

Conversation

ronso0
Copy link
Member

@ronso0 ronso0 commented Dec 8, 2024

While fixing mixxxdj/mixxx#14000 for me I noticed the scratch controls documentation is incomplete.

Completes the engine scratch function names and adds links to https://github.com/mixxxdj/mixxx/wiki/midi%20scripting#scratching-and-jog-wheels

Furthermore I'd like to clarify if/why the engine.scratch.. functions should be preferred over engine.setValue(group, "scratch2...
For example engine.scratchTick(deck, ticks) vs. engine.setValue(group, "scratch2", speed).
Will start a thread on Zulip soonish.

@JoergAtGithub
Copy link
Member

@ronso0
Copy link
Member Author

ronso0 commented Dec 30, 2024

Okay, what are you proposing?

IIUC engine-api.d.ts is only discoverable when you use a js IDE. Shall we mention it in https://github.com/mixxxdj/mixxx/wiki/midi%20scripting ?

@JoergAtGithub
Copy link
Member

I just referenced, as we have already this reviewed documentation text.
A mention of the .ts file in the manual would be helpful too.
BTW: I originally proposed to render the formal API docu into the manual as shown in this POC: https://github.com/mixxxdj/manual/blob/581e6b9ddcb3e7643a1c93864abceac33f617fc2/source/chapters/controller_api/modules/engine_api.engine.md#scratchenable

@ronso0
Copy link
Member Author

ronso0 commented Dec 30, 2024

Ah okay, I vaguely remember that!

Do you think I should add a loink to all controls I touched here?
Otherwise a separate PR would be better IMO.

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.

2 participants