[ISSUE-30] update README.md

ozontech · Aug 23, 2022 · 32923b6 · 32923b6
1 parent 5a1f8db
commit 32923b6
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/pkg/framework/README.md b/pkg/framework/README.md
@@ -53,10 +53,12 @@ Main interfaces for test working are `provider.T` and `provider.StepCtx`.
 
 ##### Description Methods (`DescriptionFields` interface)
 
-| Method                            |           Description           |
-|:----------------------------------|:-------------------------------:|
-| `Title(title string)`             |    Sets `result.Name` field     |
-| `Description(description string)` | Sets `result.Description` field |
+| Method                                             |                    Description                     |
+|:---------------------------------------------------|:--------------------------------------------------:|
+| `Title(args ...interface{})`                       |     Sets `result.Name` field, using fmt.Sprint     |
+| `Titlef(format string, args ...interface{})`       |    Sets `result.Name` field, using fmt.Sprintf     |
+| `Description(args ...interface{})`                 |  Sets `result.Description` field, using fmt.Sprint |
+| `Descriptionf(format string, args ...interface{})` | Sets `result.Description` field, using fmt.Sprintf |
 
 ##### Suite Methods (`SuiteLabels` interface)
 
@@ -474,4 +476,4 @@ func (s *ParametrizedSuite) TableTestCities(t provider.T, city string) {
 func TestNewParametrizedDemo(t *testing.T) {
 	suite.RunSuite(t, new(ParametrizedSuite))
 }
-```
+```