Fix incorrect documentation for schedule time format #232
Conversation
…ation for timezones.
|
@gschneider-r7 @sgreen-r7 cleared up some of the comments around schedule start time format and added in some notes around timezones. |
| @@ -154,11 +149,12 @@ class Schedule < APIObject | |||
| attr_accessor :day | |||
| attr_accessor :occurrence | |||
| attr_accessor :start_month | |||
| # Timezone cannot be set, always console timezone. If console timezone is not supported defaults to utc. | |||
| attr_accessor :timezone | |||
There was a problem hiding this comment.
Does this comment only apply on write, or also read?
There was a problem hiding this comment.
I'll reword this, timezone can be read back from the site schedule. But when creating a schedule adding a timezone will do nothing.
| @@ -154,11 +149,12 @@ class Schedule < APIObject | |||
| attr_accessor :day | |||
| attr_accessor :occurrence | |||
| attr_accessor :start_month | |||
| # Timezone cannot be set on schedule create, it is set to console timezone. If console timezone is not supported it defaults to utc. | |||
| # The amount of time, in minutes, to allow execution before stopping. | ||
| attr_accessor :max_duration | ||
| # The date after which the schedule is disabled, in ISO 8601 format. | ||
| attr_accessor :not_valid_after | ||
|
|
||
| # TODO: Remove this unused attribute | ||
| attr_accessor :incremental |
There was a problem hiding this comment.
I think this is fine to remove without needing to bump major version. @sgreen-r7 agree?
There was a problem hiding this comment.
No. 😃
Also, if we're removing that attr, then we should remove the other places in the code that are calling it. schedule.incremental = (xml.attributes['incremental'] && xml.attributes['incremental'] == '1'))
|
Looks good to me @dmurray-r7 And we will do a major version bump now for sure 😄 |
|
@sgreen-r7 @gschneider-r7 Happy enough for this to be merged in? |
|
I'm fine with it, @gschneider-r7 ? |
|
🚢 it |
No description provided.