From 7f79860e52131f8545a27961f7128d4851d08d65 Mon Sep 17 00:00:00 2001
From: NikVolf <nikvolf@gmail.com>
Date: Thu, 18 Jan 2018 19:28:57 +0300
Subject: [PATCH] add doc comment

---
 src/elements/module.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/elements/module.rs b/src/elements/module.rs
index f85af7a..2ab50d8 100644
--- a/src/elements/module.rs
+++ b/src/elements/module.rs
@@ -144,6 +144,10 @@ impl Module {
         None
     }
 
+    /// Try to parse name section in place
+    /// Corresponding custom section with proper header will convert to name sections
+    /// If some of them will fail to be decoded, Err variant is returned with the list of
+    /// (index, Error) tuples of failed sections.
     pub fn parse_names(mut self) -> Result<Self, (Vec<(usize, Error)>, Self)> {
         let mut parse_errors = Vec::new();