-
Notifications
You must be signed in to change notification settings - Fork 85
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
crow 4.0 doc suggestions #385
Comments
i'm a bit confused by the explanation in the the doc states timelines are different than similarly, the docs states "You'll only use |
@jaseknighter agreed this is a confusing. for reference (and to try to dial into what we're trying to say), when i saw "pre" and "post", the "centre" (ie the thing you put methods before and after) is the core function that takes the time-event-pairs table. this is in timeline, the thing that actually runs the timeline, is one of those 3 core functions (loop, score, real). all the pre & post methods modify that core function's behaviour. does this make sense? if so, i guess we should make a point of giving these 3 core functions a special name. even calling them the "core" functions should be fine, but perhaps there's a better word. for me it's all about "the function that takes the timeline table". ahhh "timeline table" is confusing too! "core functions (loop, score, real) take the time-event table that describes your timeline's action over time. all pre-methods go before this function, where post-methods come after" example usage: t = timeline.queue() -- won't start immediately. call `:play()` to start it
:loop{} -- time-event table
:times(n)
t:play() -- start the timeline
timeline.launch(n) -- set launch quantization to n beats
:loop{} -- time-event table
:unless(f) -- f is a boolean, or a predicate function that returns a boolean
timeline.queue():launch(n) -- queue it, and set launch quantization
:score{} -- time-event table
timeline.queue():launch(n)
:real{} -- time-event table |
@trentgill, thanks for the explanation. i think i understand how this works better now. looking over the doc again, i think this statement is very helpful: "Pre-methods are about changing when a timeline will begin, whereas post-methods are about how they run, or when they will stop" regarding the name of the "core functions," i was thinking what makes them core, is they set the 'mode' of the timeline. |
@jaseknighter glad this helped clarify things. my hesitation about calling them the i guess it is quite similar to the perhaps @dndrks has other thoughts (they've always had great naming ideas!) |
in the docs, trent naturally used "the behavior of the main function ( but also, just to confirm (@trentgill): only |
@dndrks yes indeed. i feel like i've made the description overly complicated by talking about pre&post in such general terms. there's only 4 'extra' methods in total, and 2 of them are i guess i was leaving room for more of this stuff in the future (to respond to common things people other than myself want to do with the library), but that is premature optimization to be sure! i think we should probably just talk about adding "pre" methods for launch&queue. then have a separate section about loop conditions where we can describe |
(EDIT: resolved in crow 4.0.1...no additional documentation required) re: hotswapping sequins... i was thinking i could apply an arithmetic operator hotswapped sequins like:
but it doesn't appear to work. however, this appears to work:
assuming my findings are correct, i'd say it would help to have a section in the hotswap doc about applying operators and provides an example or two. also, based on my very basic understanding of how it works, there are a couple of points that would be worth highlighting:
|
@jaseknighter i fixed the behaviour you mentioned. you were correct that hotswapping a sequins where the change is the addition of a transformer wouldn't work, but now it does. in general, i'd say your intuition as to how it should work was correct, there was just a couple bugs that precluded this from happening which are now fixed. |
rad, everything's been launched! thank you @jaseknighter for the fantastic feedback + invaluable test driving!! |
starting an issue to collect feedback from folks on discord re: crow 4.0 docs!
The text was updated successfully, but these errors were encountered: