update retirement calls #1405
update retirement calls #1405
Conversation
use retirement as a request calls instead of the older retirement calls
|
Checked commit d-m-u@913d6c4 with ruby 2.5.7, rubocop 0.69.0, haml-lint 0.28.0, and yamllint |
|
The API currently supports both, retire and request_retire. Documentation should reflect this. |
|
Then we should make it clearer in these docs what the differences between the two are because I keep fixing bugs where people are using the wrong call. |
|
That's fine, unless we are going to throw away/deprecate the old one, let's document both and clearly describe the difference. |
|
Alright but I would have thought that for this overview page especially we'd at least have examples that are up-to-date. Since the only reason we still have the old call is backwards compatibility and everything else is using the request call, it isn't really user-friendly to be using the old example here. |
|
Ok, if the old one is kept around for compatibility, then we could deprecate it at some point. Then, yes, let's just document request_retire. 👍 |
|
Deprecating it would break retirement for any pre-Hammer state machine, which is why I think we don't want to deprecate it. But since its functionality has that limit, I do think these docs for any relevant release should be using the request call. |
use retirement as a request calls instead of the older retirement calls