SBO::Lib::Readme: add documentation for ask_other_readmes

1 files changed, 10 insertions, 0 deletions

diff --git a/SBO-Lib/lib/SBO/Lib/Readme.pm b/SBO-Lib/lib/SBO/Lib/Readme.pm
index f01c923..e8f27f0 100644
--- a/SBO-Lib/lib/SBO/Lib/Readme.pm
+++ b/SBO-Lib/lib/SBO/Lib/Readme.pm
@@ -77,6 +77,16 @@ sub ask_opts {
   return();
 }
 
+=head2 ask_other_readmes
+
+  ask_other_readmes($sbo, $location);
+
+C<ask_other_readmes()> checks if there are other readmes for the C<$sbo> in
+C<$location>, and if so, asks the user if they should be displayed, and then
+displays them if the user didn't decline.
+
+=cut
+
 sub ask_other_readmes {
   my ($sbo, $location) = @_;
   my @readmes = sort grep { ! m!/README$! } glob "$location/README*";