fix docstrings

kpinter-iohk · kpinter-iohk · commit 387d823c3629 · 2025-11-12T16:40:16.000+01:00
diff --git a/toolkit/data-sources/db-sync/src/candidates/cached.rs b/toolkit/data-sources/db-sync/src/candidates/cached.rs
@@ -97,7 +97,7 @@ impl CandidateDataSourceCacheConfig {
 }
 
 impl CandidateDataSourceCached {
-	/// TODO
+	/// Creates new instance of the data source
 	pub fn new(
 		inner: CandidatesDataSourceImpl,
 		candidates_for_epoch_cache_size: usize,
@@ -116,7 +116,7 @@ impl CandidateDataSourceCached {
 		}
 	}
 
-	/// TODO
+	/// Creates a new instance of the data source, reading configuration from the environment.
 	pub fn new_from_env(
 		inner: CandidatesDataSourceImpl,
 		candidates_for_epoch_cache_size: usize,

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ impl CandidateDataSourceCacheConfig {`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`impl CandidateDataSourceCached {`
`100`		`- /// TODO`
	`100`	`+ /// Creates new instance of the data source`
`101`	`101`	`pub fn new(`
`102`	`102`	`inner: CandidatesDataSourceImpl,`
`103`	`103`	`candidates_for_epoch_cache_size: usize,`
`@@ -116,7 +116,7 @@ impl CandidateDataSourceCached {`
`116`	`116`	`}`
`117`	`117`	`}`
`118`	`118`
`119`		`- /// TODO`
	`119`	`+ /// Creates a new instance of the data source, reading configuration from the environment.`
`120`	`120`	`pub fn new_from_env(`
`121`	`121`	`inner: CandidatesDataSourceImpl,`
`122`	`122`	`candidates_for_epoch_cache_size: usize,`