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

schelp Object.dump update: more explanation with case examples #6292

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

Conversation

prko
Copy link
Contributor

@prko prko commented May 4, 2024

Purpose and Motivation

The explanation of .dump is too minimal and abstract. I have summarised what I learned from scsynth.org and the old mailing list.
In particular, the following thread was helpful:

Thanks to @telephon, @dkmayer, @adcxyz, @jamshark70, and @mossheim!

I have added explanations that are as detailed as possible and as simple as possible for those new to SuperCollider with no programming experience.

I hope this can be approved and merged if the content is correct.
In the hope that someone will let me correct the wrong information rather than be ignored, so that this PR can help someone like me without having to search the internet.

PDF files of the corresponding parts in the object help file:

Types of changes

  • Documentation

To-do list

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

prko added 19 commits January 1, 2024 20:03
added more explanation on equality, identity and dump
Help document update: equality, identity and dump across four files
update documentation: equlity, identity and dump across files uploaded
added more explanation on equality, identity and dump
Help document update: equality, identity and dump across four files
update documentation: equlity, identity and dump across files uploaded
@prko prko changed the title schelp update: .dump more explanation with examples by cases schelp Object.dump update: more explanation with case examples May 5, 2024
@JordanHendersonMusic JordanHendersonMusic added the comp: help schelp documentation label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp: help schelp documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants