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

Add cut and legato, move sample trimming related functions to their own page #269

Merged
merged 7 commits into from
Apr 30, 2024

Conversation

Asmatzaile
Copy link
Contributor

There were a lot of functions that dealt with trimming samples and I felt there was the need to classify them in functions that trim samples in an absolute manner (sustain), functions that trim them relative to their length (begin, end, grain...) and functions that trim them relative to the events of the pattern (cut, legato).
I did that classification and I moved them to their own page. Is there a way I have to link the page so that it appears in the documentation?

@trespaul
Copy link
Collaborator

trespaul commented Apr 20, 2024

Hey! So, we're currently reconsidering the structure of the documentation (preview at https://tidal-doc.pages.dev, source at https://github.com/trespaul/tidal-doc), including the reference section, which I personally am of the opinion should reflect the modules as they are in the Tidal source code. We're following the "Grand Unified Theory of Documentation", so we're keeping guides and reference sections separate. Please take a look at the new site and let us know what you think! Specifically, do you think we should make a guide for sample trimming functions?

@Asmatzaile
Copy link
Contributor Author

Nice restructuring!
I do like that now the reference reflects how the code is structured in hackage and the guides port the information that was in the previous documentation.
I do think there should be a guide for sample trimming functions, for a couple of reasons: a) I think these functions are very related conceptually, and it's therefore good that they are grouped together in a page. b) has some readily available information about changing 'legato' and 'cut' that I spent some time researching and could be of use to other classical musicians.
In fact, I have been thinking about how the functions could be better grouped, and I was getting made to make another PR with that (currently, 'samples' and 'sampling' are a little bit confusing).
For now, I would definitely create that new guide about sample trimming functions. Should I go ahead and do it?

@trespaul
Copy link
Collaborator

Since you've already made the page, I'm happy to add it to my fork and tag you for credit, or if you like, you can open a PR on that repo. Regarding the organisation of the functions: there has been some discussion about that; we're talking about it on the Discord, if you'd like to join, or if you don't have a discord account we can discuss on github somewhere.

@Asmatzaile
Copy link
Contributor Author

Asmatzaile commented Apr 20, 2024

Okay, thanks! Checked the discord, and just made a PR in your repo!

@yaxu
Copy link
Member

yaxu commented Apr 21, 2024

should reflect the modules as they are in the Tidal source code

We could also say vice-versa, as the organisation in source isn't necessarily perfect.

In the meantime shall we merge this PR?

@trespaul
Copy link
Collaborator

We could also say vice-versa

Yes, you're right, I meant to say that they should be in sync 😅

@cleary
Copy link
Collaborator

cleary commented Apr 30, 2024

In the meantime shall we merge this PR?

They're key functions imo, so 👍 from me

@cleary cleary mentioned this pull request Apr 30, 2024
@yaxu yaxu merged commit e4b9116 into tidalcycles:main Apr 30, 2024
2 checks passed
@yaxu
Copy link
Member

yaxu commented Apr 30, 2024

Done, thanks!

@Asmatzaile Asmatzaile deleted the patch-4 branch April 30, 2024 08:24
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.

4 participants