From e778f248ffc510990b62d3cb8a1021b40c7d2e1c Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Sat, 17 Feb 2024 16:40:26 -0300 Subject: [PATCH] make readme more detailed --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 39c86f6..f049e62 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,10 @@ [![Go](https://github.com/janos/singleflight/workflows/Go/badge.svg)](https://github.com/janos/singleflight/actions?query=workflow%3AGo) Package singleflight provides a duplicate function call suppression -mechanism similar to golang.org/x/sync/singleflight but with support -for context cancelation. +mechanism similar to [golang.org/x/sync/singleflight](https://pkg.go.dev/golang.org/x/sync/singleflight) but with support +for context cancelation. The context passed to the callback function is a context that preserves all values +from the passed context but is cancelled by the singleflight only when all +awaiting caller's contexts are cancelled. ## Installation