Add docstrings to SearchFilters methods #298

New issue

Open

opened 2024-11-20 09:34:06 +00:00 by potyarkin · 0 comments

potyarkin commented

2024-11-20 09:34:06 +00:00

Member

We should add docstrings to SearchFilters methods because for most of them the functionality is not obvious based on the call signature alone.

I've recently learned that (*SearchFilters).AddRootFilter is kinda important and is rather useful for client-side search calls. I knew it exsited from godoc but without the docstring I assumed its purpose incorrectly and did not use it.

I would prepare a PR myself but unfortunately I lack relevant knowledge.

We should add docstrings to [SearchFilters methods](https://pkg.go.dev/git.frostfs.info/TrueCloudLab/frostfs-sdk-go@v0.0.0-20241113074125-afdc2d8340bb/object#SearchFilters) because for most of them the functionality is not obvious based on the call signature alone. I've recently learned that `(*SearchFilters).AddRootFilter` is kinda important and is rather useful for client-side search calls. I knew it exsited from [godoc](https://pkg.go.dev/git.frostfs.info/TrueCloudLab/frostfs-sdk-go@v0.0.0-20241113074125-afdc2d8340bb/object#SearchFilters.AddRootFilter) but without the docstring I assumed its purpose incorrectly and did not use it. I would prepare a PR myself but unfortunately I lack relevant knowledge.