diff options
Diffstat (limited to 'mod/mod-ci-github-gq.hxx')
| -rw-r--r-- | mod/mod-ci-github-gq.hxx | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/mod/mod-ci-github-gq.hxx b/mod/mod-ci-github-gq.hxx index 39d2c7e..0fc3817 100644 --- a/mod/mod-ci-github-gq.hxx +++ b/mod/mod-ci-github-gq.hxx @@ -49,7 +49,8 @@ namespace brep // Throw invalid_argument if the passed data is invalid, missing, or // inconsistent. // - // If the details_url is absent GitHub will use the app's homepage. + // If the details_url is absent GitHub will use the app's homepage. Title + // and summary are required and cannot be empty. // bool gq_create_check_run (const basic_mark& error, @@ -59,13 +60,11 @@ namespace brep const string& head_sha, const optional<string>& details_url, build_state, - string title, string summary); + string title, + string summary); - // As above but create a check run in the built state. - // - // Note that a conclusion is required for the built state. And if a - // conclusion is provided with a queued or building state GitHub will change - // the state to built. + // As above but create a check run in the built state (which requires a + // conclusion). // struct gq_built_result { |