From fe33ed6e75c345de6612c4c23cb67480f86f3357 Mon Sep 17 00:00:00 2001 From: Matthew Rothenberg Date: Fri, 5 May 2017 11:14:01 -0400 Subject: [PATCH] update godoc description --- suite_context.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/suite_context.go b/suite_context.go index 4201891..b439d68 100644 --- a/suite_context.go +++ b/suite_context.go @@ -14,10 +14,12 @@ import ( "github.com/DATA-DOG/godog/gherkin" ) -// SuiteContext can be used for meta-testing of godog features/steps themselves. +// SuiteContext provides steps for godog suite execution and +// can be used for meta-testing of godog features/steps themselves. // -// A typical user of the godog library should never need this, rather it is -// provided for those developing add-on libraries for godog. +// Beware, steps or their definitions might change without backward +// compatibility guarantees. A typical user of the godog library should never +// need this, rather it is provided for those developing add-on libraries for godog. // // For an example of how to use, see godog's own `features/` and `suite_test.go`. func SuiteContext(s *Suite, additionalContextInitializers ...func(suite *Suite)) {