From: Jeff Ober <jober@ziprecruiter.com>
Date: Mon, 13 Jan 2020 19:34:31 +0000 (-0500)
Subject: Add ABSTRACT for all modules, document TOML::Tiny::Grammar
X-Git-Tag: nailing-cargo/1.0.0~234^2~45
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=3733533f7e3e2fb5f49389b911966fef16243fcd;p=nailing-cargo.git

Add ABSTRACT for all modules, document TOML::Tiny::Grammar
---

diff --git a/README.pod b/README.pod
index 7ef69a1..4faa974 100644
--- a/README.pod
+++ b/README.pod
@@ -30,7 +30,8 @@ version 0.01
 
   # Object API
   my $parser = TOML::Tiny->new;
-  my $result = $parser->parse($toml);
+  my $data = $parser->decode($toml);
+  say $parser->encode($data);
 
 =head1 DESCRIPTION
 
@@ -151,7 +152,9 @@ overriding the parser by setting C<$TOML::Parser>.
 
 =head1 DIFFERENCES FROM TOML AND TOML::Parser MODULES
 
-=head1 TOML VERSION COMPATIBILITY
+L<TOML> defaults to lax parsing and provides C<strict_mode> to (slightly)
+tighten things up. C<TOML::Tiny> defaults to strict parsing, with the exception
+of optionally setting C<strict_arrays>.
 
 =head1 AUTHOR
 
diff --git a/lib/TOML/Tiny/Grammar.pm b/lib/TOML/Tiny/Grammar.pm
index ff3a781..df365a9 100644
--- a/lib/TOML/Tiny/Grammar.pm
+++ b/lib/TOML/Tiny/Grammar.pm
@@ -1,4 +1,5 @@
 package TOML::Tiny::Grammar;
+# ABSTRACT: exports regex definition of TOML grammar
 
 use strict;
 use warnings;
@@ -247,3 +248,44 @@ our $TOML = qr{
 }x;
 
 1;
+
+=head1 SYNOPSIS
+
+  use TOML::Tiny::Grammar;
+
+  if ($src =~ /(?&MultiLineString) $TOML/x) {
+    ...
+  }
+
+=head1 DESCRIPTION
+
+Exports C<$TOML>, a regex grammar for parsing TOML source.
+
+=head1 RULES
+
+=head2 (?&WS)
+=head2 (?&NL)
+=head2 (?&Comment)
+
+=head2 (?&Value)
+=head3 (?&Boolean)
+=head3 (?&DateTime)
+=head3 (?&Float)
+=head3 (?&Integer)
+=head3 (?&String)
+=head3 (?&Array)
+=head3 (?&InlineTable)
+
+=head2 (?&Key)
+=head3 (?&BareKey)
+=head3 (?&QuotedKey)
+=head3 (?&DottedKey)
+
+=head2 (?&ArrayOfTables)
+=head2 (?&KeyValuePair)
+=head2 (?&KeyValuePairDecl)
+=head2 (?&TableDecl)
+=head2 (?&Table)
+=head2 (?&Array)
+
+=cut
diff --git a/lib/TOML/Tiny/Parser.pm b/lib/TOML/Tiny/Parser.pm
index e20a314..8da34eb 100644
--- a/lib/TOML/Tiny/Parser.pm
+++ b/lib/TOML/Tiny/Parser.pm
@@ -1,4 +1,5 @@
 package TOML::Tiny::Parser;
+# ABSTRACT: parser used by TOML::Tiny
 
 use strict;
 use warnings;
diff --git a/lib/TOML/Tiny/Tokenizer.pm b/lib/TOML/Tiny/Tokenizer.pm
index 3ea9b3c..e3150bb 100644
--- a/lib/TOML/Tiny/Tokenizer.pm
+++ b/lib/TOML/Tiny/Tokenizer.pm
@@ -1,4 +1,5 @@
 package TOML::Tiny::Tokenizer;
+# ABSTRACT: tokenizer used by TOML::Tiny
 
 use strict;
 use warnings;
diff --git a/lib/TOML/Tiny/Util.pm b/lib/TOML/Tiny/Util.pm
index c5fc35f..c18af79 100644
--- a/lib/TOML/Tiny/Util.pm
+++ b/lib/TOML/Tiny/Util.pm
@@ -1,4 +1,5 @@
 package TOML::Tiny::Util;
+# ABSTRACT: utility functions used by TOML::Tiny
 
 use strict;
 use warnings;