Merge pull request #1394 from antonilol/palette_doc

fix function docs of Palette::new
Rust-SDL2 · Jun 13, 2024 · c4ed97c · c4ed97c
2 parents 4e9af37 + 7c6b24c
commit c4ed97c
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/sdl2/pixels.rs b/src/sdl2/pixels.rs
@@ -10,7 +10,9 @@ pub struct Palette {
 
 impl Palette {
     #[inline]
-    /// Creates a new, uninitialized palette
+    /// Create a palette structure with the specified number of color entries.
+    ///
+    /// The palette entries are initialized to white.
     #[doc(alias = "SDL_AllocPalette")]
     pub fn new(mut capacity: usize) -> Result<Self, String> {
         use crate::common::*;