doc: explain methods

Author: Devdutt Shenoi

src/parseable/mod.rs

@@ -829,6 +829,7 @@ impl Parseable {
         Some(first_event_at.to_string())
     }
 
+    /// Updates schema by merging schemas stored by ingestors when running in Query mode
     pub async fn update_schema_when_distributed(
         &self,
         tables: &Vec<String>,

src/parseable/streams.rs

@@ -538,6 +538,7 @@ impl Stream {
         Schema::try_merge(vec![schema, current_schema]).unwrap()
     }
 
+    /// Stores updated schema in-memory
     pub fn commit_schema(&self, schema: Schema) -> Result<(), StagingError> {
         let mut metadata = self.metadata.write().expect(LOCK_EXPECT);
         let current_schema = Schema::new(metadata.schema.values().cloned().collect::<Fields>());

src/storage/object_storage.rs

@@ -870,6 +870,7 @@ pub trait ObjectStorage: Debug + Send + Sync + 'static {
         Ok(())
     }
 
+    /// Stores updated schema into storage
     async fn commit_schema(
         &self,
         stream_name: &str,