From 970300d25a97ec9ded87a23686fa791a456a70d4 Mon Sep 17 00:00:00 2001 From: John Mulligan Date: Wed, 5 Feb 2020 14:32:21 -0500 Subject: [PATCH] rados: fix doc comments for omap related functions This is a minor cleanup that only stops the checker from complaining rather than actually improving the documentation. Signed-off-by: John Mulligan --- rados/omap.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/rados/omap.go b/rados/omap.go index 0727145..bea0dda 100644 --- a/rados/omap.go +++ b/rados/omap.go @@ -70,7 +70,9 @@ func (ioctx *IOContext) SetOmap(oid string, pairs map[string][]byte) error { // visited by ListOmapValues type OmapListFunc func(key string, value []byte) -// Iterate on a set of keys and their values from an omap +// ListOmapValues iterates over the keys and values in an omap by way of +// a callback function. +// // `startAfter`: iterate only on the keys after this specified one // `filterPrefix`: iterate only on the keys beginning with this prefix // `maxReturn`: iterate no more than `maxReturn` key/value pairs @@ -131,7 +133,7 @@ func (ioctx *IOContext) ListOmapValues(oid string, startAfter string, filterPref return nil } -// Fetch a set of keys and their values from an omap and returns then as a map +// GetOmapValues fetches a set of keys and their values from an omap and returns then as a map // `startAfter`: retrieve only the keys after this specified one // `filterPrefix`: retrieve only the keys beginning with this prefix // `maxReturn`: retrieve no more than `maxReturn` key/value pairs @@ -148,7 +150,7 @@ func (ioctx *IOContext) GetOmapValues(oid string, startAfter string, filterPrefi return omap, err } -// Fetch all the keys and their values from an omap and returns then as a map +// GetAllOmapValues fetches all the keys and their values from an omap and returns then as a map // `startAfter`: retrieve only the keys after this specified one // `filterPrefix`: retrieve only the keys beginning with this prefix // `iteratorSize`: internal number of keys to fetch during a read operation