supercollider icon indicating copy to clipboard operation
supercollider copied to clipboard

More explanation on equality, identity and dump across Object, SimpleNumber, SequenceableCollection and String

Open prko opened this issue 1 year ago • 5 comments

Purpose and Motivation

The explanations on equality, identity and dumping are too short. If I remember correctly, there were some questions about this, including some of mine:

https://scsynth.org/t/understanding-the-result-of-dump-low-level-data-for-float-hexadecimal-for-string-gc-fmt-flg-and-set/8553/3

I have added explanations that are as detailed as possible and as simple as possible for those new to SuperCollider without programming experience. Please let me correct the updated information if the content is wrong. I also do not mind if someone opens a new PR using this one, because I am not sure about my English. If someone wants to close it with their own PR, I will be happy to close it too!

Thanks to @jamshark70 and @mossheim!

Types of changes

To-do list

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

prko avatar Jan 01 '24 11:01 prko

Thank you for your kind and valuable feedback!

The added sections in String.schelp and SequenceableCollection.schelp are very similar in form. However, I have left some tables in the Identity section in SequenceableCollection.schelp because I think the readability of the corresponding section in String.schelp is not so good. Please compare them and give me feedback. Object _ SuperCollider 3.14.0-dev Help.pdf SequenceableCollection _ SuperCollider 3.14.0-dev Help.pdf SimpleNumber _ SuperCollider 3.14.0-dev Help.pdf String _ SuperCollider 3.14.0-dev Help.pdf

prko avatar Jan 03 '24 14:01 prko

@prko I won't get to this anytime soon, if you need a quick review please find someone else to do it. :)

mossheim avatar Jan 17 '24 15:01 mossheim

@mossheim It is not urgent! I have very little experience with this, and I pressed the re-request to inform you that I did your change request. I can wait until you or someone else can review it. Thanks!

prko avatar Jan 17 '24 16:01 prko

Ok, all good, thanks for your patience

mossheim avatar Jan 17 '24 16:01 mossheim

I can wait until you or someone else can review it. Thanks!

FYI not contributing to this project anymore, someone else can pick it up.

mossheim avatar Feb 16 '24 12:02 mossheim