📝 testing: allow examples with any signature
Небольшое «Quality of Life» предложение. Суть: давайте разрешим функциям Example*, которые мы используем для документации, принимать и возвращать любое число аргументов. Запрос связан с тем, что сейчас многие вещи не выразить в примерах. Например примеры для пакетов нацеленных на тестирование.
Те в документации станет отображаться следующий код:
func Example_Functionname(t *testing.T) {
t.Logf("foobar")
}
Единственным ограничением является то, что в отличии от безаргументных Example* функций, они не смогут содержать // Output: комментарии.
func Example_Functionname(t *testing.T) { // will not compile
t.Logf("foobar")
// Output: foobar
}
Напомню, что такие комментарии автоматически переводят примеры в тесты — их прогоняет go test и сверяет их вывод с тем, что идёт в блоке комментария после Output. Что было довольно удобно для проверки (и сохранения!) корректности этих самых примеров. Решать сие предлагают через написание тестов, которые будут вызывать эти примеры напрямую — т.е. точно так-же как мы тестируем обычные функции.
Текущий статус accepted, и будет сие вероятно частью релиза 1.28.
Небольшое «Quality of Life» предложение. Суть: давайте разрешим функциям Example*, которые мы используем для документации, принимать и возвращать любое число аргументов. Запрос связан с тем, что сейчас многие вещи не выразить в примерах. Например примеры для пакетов нацеленных на тестирование.
Те в документации станет отображаться следующий код:
func Example_Functionname(t *testing.T) {
t.Logf("foobar")
}
Единственным ограничением является то, что в отличии от безаргументных Example* функций, они не смогут содержать // Output: комментарии.
func Example_Functionname(t *testing.T) { // will not compile
t.Logf("foobar")
// Output: foobar
}
Напомню, что такие комментарии автоматически переводят примеры в тесты — их прогоняет go test и сверяет их вывод с тем, что идёт в блоке комментария после Output. Что было довольно удобно для проверки (и сохранения!) корректности этих самых примеров. Решать сие предлагают через написание тестов, которые будут вызывать эти примеры напрямую — т.е. точно так-же как мы тестируем обычные функции.
Текущий статус accepted, и будет сие вероятно частью релиза 1.28.