From f18a9852db5c8dd601eb35a7ede710e5724f9b44 Mon Sep 17 00:00:00 2001 From: Simone Basso Date: Tue, 17 Aug 2021 12:52:51 +0200 Subject: [PATCH] doc: mention the test helper spec we're using (#436) See https://github.com/ooni/probe/issues/1729 --- .../cmd/oohelperd/internal/websteps/websteps.go | 5 ++++- internal/engine/experiment/websteps/websteps.go | 13 +++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/internal/cmd/oohelperd/internal/websteps/websteps.go b/internal/cmd/oohelperd/internal/websteps/websteps.go index ca0720e..ee7f899 100644 --- a/internal/cmd/oohelperd/internal/websteps/websteps.go +++ b/internal/cmd/oohelperd/internal/websteps/websteps.go @@ -1,6 +1,9 @@ // Package websteps implements the websteps test helper. // -// See https://github.com/ooni/spec/blob/master/backends/th-007-nwcth.md +// See the https://github.com/ooni/spec/blob/master/backends/th-007-websteps.md +// related specification document. +// +// This implementation uses version 202108.17.1114 of the spec. package websteps import ( diff --git a/internal/engine/experiment/websteps/websteps.go b/internal/engine/experiment/websteps/websteps.go index 5622ac0..71bc1ed 100644 --- a/internal/engine/experiment/websteps/websteps.go +++ b/internal/engine/experiment/websteps/websteps.go @@ -1,3 +1,16 @@ +// Package websteps implements the websteps experiment. +// +// Specifications: +// +// - test helper: https://github.com/ooni/spec/blob/master/backends/th-007-websteps.md +// +// - experiment: N/A. +// +// We are currently implementing: +// +// - version 202108.17.1114 of the test helper spec. +// +// - version N/A of the experiment spec. package websteps import (