From 71667ff3da99f0838f2f41b3cab0afe7852d44a8 Mon Sep 17 00:00:00 2001
From: broccoliSpicy <broccoli.spicy@outlook.com>
Date: Wed, 9 Oct 2024 20:56:15 +0000
Subject: [PATCH] add documentation to the Encoding enum

---
 rust/lance-encoding/src/data.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/rust/lance-encoding/src/data.rs b/rust/lance-encoding/src/data.rs
index 066528b692..7388dc3f5e 100644
--- a/rust/lance-encoding/src/data.rs
+++ b/rust/lance-encoding/src/data.rs
@@ -31,6 +31,10 @@ use lance_core::{Error, Result};
 
 use crate::{buffer::LanceBuffer, statistics::Stat};
 
+/// `Encoding` enum serves as a encoding registeration center.
+/// All the encodings added to Lance should register here, and
+/// these encodings can be dynamically selected during encoding,
+/// users can also specify the particular encoding they want to use in the field metadata.
 #[derive(Debug)]
 pub enum Encoding {
     Bitpack,