note that AttachProgressReporter is an experimental feature

Author: onsi

core_dsl.go

@@ -775,6 +775,8 @@ func DeferCleanup(args ...interface{}) {
 /*
 AttachProgressReporter allows you to register a function that will be called whenever Ginkgo generates a Progress Report.  The contents returned by the function will be included in the report.
 
+**This is an experimental feature and the public-facing interface may change in a future minor version of Ginkgo**
+
 Progress Reports are generated:
 - whenever the user explicitly requests one (via `SIGINFO` or `SIGUSR1`)
 - on nodes decorated  with PollProgressAfter

docs/index.md

@@ -2683,6 +2683,8 @@ In addition to these formal Progress Reports, Ginkgo tracks whenever a node begi
 
 #### Attaching Additional Information to Progress Reports
 
+**This section describes an experimental feature and the public-facing interface may change in a future minor version of Ginkgo**
+
 Ginkgo also allows you to attach Progress Report providers to provide additional information when a progress report is generated.  For example, these could query the system under test for diagnostic information about its internal state and report back.  You attach these providers via `AttachProgressReporter`.  For example:
 
 ```go

ginkgo_t_dsl.go

@@ -36,7 +36,7 @@ func GinkgoT(optionalOffset ...int) FullGinkgoTInterface {
 }
 
 /*
-The interface returned by GinkgoT().  This covers most of the methods in the testing package's T.
+The portion of the interface returned by GinkgoT() that maps onto methods in the testing package's T.
 */
 type GinkgoTInterface interface {
 	Cleanup(func())
@@ -60,6 +60,9 @@ type GinkgoTInterface interface {
 	TempDir() string
 }
 
+/*
+Additional methods returned by GinkgoT() that provide deeper integration points into Ginkgo
+*/
 type FullGinkgoTInterface interface {
 	GinkgoTInterface