read-only fixes - #45
Conversation
|
Yes, only the observables should have been marked as read-only here. But moving the READ-ONLY tag to the end of the ---**READ-ONLY** Selected in the instrument box.
---@field selected_instrument renoise.InstrumentThis shows ---Selected in the instrument box.
---@field selected_instrument renoise.Instrument **READ-ONLY**This now only shows |
|
Fixed that and some other cases where the same thing silently omitted available descriptions (mostly when a "Range" was specified after the type). Added a few more missing read-only tags, and narrowed the types for ranges as two item tables instead of just a Removed some descriptions that were literally just the name of the field capitalized, more of these remain for another clean-up. There are also cases where the description for one field is treated as a kind of header for multiple fields below it, this makes sense when reading the actual annotation source but less so when rendered in the book. We might want to go through these at some point and clean up as well. An example of this (still in ---Song Comments
---@field artist string
---@field artist_observable renoise.Document.Observable **READ-ONLY**
---@field name string
---@field name_observable renoise.Document.Observable **READ-ONLY**
---Note: All property tables of basic types in the API are temporary copies.
---In other words `comments = { "Hello", "World" }` will work,
---`comments[1] = "Hello"; renoise.song().comments[2] = "World"`
---will *not* work.
---@field comments string[]
---@field comments_observable renoise.Document.ObservableList **READ-ONLY**
---Notifier is called as soon as any paragraph in the comments change.
---**READ-ONLY**
---@field comments_assignment_observable renoise.Document.Observable
---Set this to true to show the comments dialog after loading a song
---@field show_comments_after_loading boolean
---@field show_comments_after_loading_observable renoise.Document.Observable **READ-ONLY**
|
|
Thanks. Works great now. |
Fixed indices in the song incorrectly being tagged
READ-ONLY, I assume you meant to tag the related observables.Unified all read-only tags to follow the "post-type" style to make the def files more uniform.
Added read-only flags to more observables along the way.
Fixed a typo.