(whimsy) branch master updated: Fix comments

[sebb]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git


The following commit(s) were added to refs/heads/master by this push:
     new 84c7498f Fix comments
84c7498f is described below

commit 84c7498fbb8e1ccd6d58af8a1265691ed1886fc2
Author: Sebb <s...@apache.org>
AuthorDate: Wed Mar 13 15:35:18 2024 +0000

    Fix comments
    
    [skip ci]
---
 lib/whimsy/asf/meeting-util.rb | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/lib/whimsy/asf/meeting-util.rb b/lib/whimsy/asf/meeting-util.rb
index e0e16fb1..d6810190 100644
--- a/lib/whimsy/asf/meeting-util.rb
+++ b/lib/whimsy/asf/meeting-util.rb
@@ -198,8 +198,10 @@ module ASF
     #  list,hdr,fmt = ASF::MeetingUtil.parse_memapp(nil, true)
     # Regenerate an indidividual entry:
     # fmt % entry
-    # Regenerate all the contents (excluding the header):
+    # Regenerate all the contents:
     #  [hdr, list.map{|item| fmt % item}].join("\n")
+    # N.B. you may need to add a trailing EOL or two
+    # when writing the file
     def self.parse_memapp(path=nil,header=false)
       path ||= get_latest_file('memapp-received.txt')
       text = File.read(path)
@@ -230,6 +232,8 @@ module ASF
     # fmt % keys.map{|key| entry[key]}
     # Regenerate all the contents:
     #  [hdr, list.map{|item| fmt % keys.map{|key| item[key]} }].join("\n")
+    # N.B. you may need to add a trailing EOL or two
+    # when writing the file
     def self.parse_memapp_to_h(path=nil,header=false)
       keys = %i(invite apply mail karma id name)
       res = self.parse_memapp(path, header)