Merge pull request #103757 from sanposhiho/fix/scheduler/framework/add-doc-on-status-reason

Add: specify that reason is a field to record the reason why failed
This commit is contained in:
Kubernetes Prow Robot 2021-08-04 22:12:46 -07:00 committed by GitHub
commit 33778cb2ba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -131,8 +131,9 @@ func NewPodsToActivate() *PodsToActivate {
}
// Status indicates the result of running a plugin. It consists of a code, a
// message, (optionally) an error and an plugin name it fails by. When the status
// code is not `Success`, the reasons should explain why.
// message, (optionally) an error and an plugin name it fails by.
// When the status code is not Success, the reasons should explain why.
// And, when code is Success, all the other fields should be empty.
// NOTE: A nil Status is also considered as Success.
type Status struct {
code Code