Skip to content

Commit 6d74a20

Browse files
committed
Update comments according to code review
1 parent d20de0d commit 6d74a20

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

bindings/cpp/include/svs/runtime/dynamic_vamana_index.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ struct SVS_RUNTIME_API DynamicVamanaIndex : public VamanaIndex {
3636

3737
virtual Status reset() noexcept = 0;
3838

39-
// Static constructors and destructors
39+
// Utility function to check storage kind support
4040
static Status check_storage_kind(StorageKind storage_kind) noexcept;
4141

42+
// Static constructors and destructors
4243
static Status build(
4344
DynamicVamanaIndex** index,
4445
size_t dim,

bindings/cpp/include/svs/runtime/flat_index.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,10 @@ namespace v0 {
2727

2828
// Abstract interface for Flat indices.
2929
struct SVS_RUNTIME_API FlatIndex {
30-
// Static constructors and destructors
30+
// Utility function to check storage kind support
3131
static Status check_storage_kind(StorageKind storage_kind) noexcept;
3232

33+
// Static constructors and destructors
3334
static Status build(FlatIndex** index, size_t dim, MetricType metric) noexcept;
3435
static Status destroy(FlatIndex* index) noexcept;
3536
virtual ~FlatIndex();

bindings/cpp/include/svs/runtime/version.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
///
2020
/// @brief Version information and API versioning for SVS Runtime
2121
///
22-
/// This header defines the SVS Runtime API versioning scheme similar to oneDAL:
22+
/// This header defines the SVS Runtime API versioning scheme:
2323
/// 1. Versioned namespaces (e.g., v0, v1) for API stability
2424
/// 2. Using declarations to bring current version to parent namespace
2525
/// 3. Clean integration points for external libraries

0 commit comments

Comments
 (0)