to - should explain the default is yourself
from - should explain the default is notifications@val.town and that you can only set it to username.valname@valtown.email addresses
cc - should explain that only available on val town pro
bcc - only available on val town pro
For iteration, see what it outputs when referenced in another val, and include that image for review in the PR (somehow) or linear. It's a lot of info, so you may have to be clever about what to include and skip, and how to say it tersely. We could also look at tweaking the setting we have for rendering jsdoc strings...
Looks like @default and the other directives aren't displayed on the auto-complete, but are displayed on hover. I'll look into displaying them when auto-completing.
to - should explain the default is yourself from - should explain the default is
notifications@val.town
and that you can only set it tousername.valname@valtown.email
addresses cc - should explain that only available on val town pro bcc - only available on val town proFor iteration, see what it outputs when referenced in another val, and include that image for review in the PR (somehow) or linear. It's a lot of info, so you may have to be clever about what to include and skip, and how to say it tersely. We could also look at tweaking the setting we have for rendering jsdoc strings...
Here's how the top-level object looks like:
Here's how the
from
parameter looks like:Looks like
@default
and the other directives aren't displayed on the auto-complete, but are displayed on hover. I'll look into displaying them when auto-completing.The
to
field should say "Only available to Val Town Pro subscribers."Then, ready to merge!