summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChad Granum <exodist7@gmail.com>2016-01-22 19:30:47 -0800
committerChad Granum <exodist7@gmail.com>2016-01-22 19:30:47 -0800
commit69f82ac8c8e82efaac13af2c222b39e8cb5f3374 (patch)
treed11d7e186bccbc0a90a0a84e1a25162e94af7b60 /README.md
parent41a42c218fe4e2849d9a298f5065d1af45c54c74 (diff)
Remove cruft, fix docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index 5541522..890e940 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,7 @@ other variables.
# \*\*\* EXPERIMENTAL \*\*\*
-This module is still experimental. Anything can change at any time. Testing is
-currently VERY insufficient.
+This module is still experimental. Anything can change at any time.
# SYNOPSYS
@@ -188,6 +187,8 @@ List of symbols to export. Sigil is optional for subs. Symbols listed here are
exported by default. If possible you should put symbols in `@EXPORT_OK`
instead.
+ our @EXPORT = qw/foo bar &baz $BAT/;
+
## @EXPORT\_OK
This is used exactly the way [Exporter](https://metacpan.org/pod/Exporter) uses it.
@@ -195,6 +196,8 @@ This is used exactly the way [Exporter](https://metacpan.org/pod/Exporter) uses
List of symbols that can be imported. Sigil is optional for subs. Symbols
listed here are not exported by default. This is preferred over `@EXPORT`.
+ our @EXPORT_OK = qw/foo bar &baz $BAT/;
+
## %EXPORT\_TAGS
This module supports tags exactly the way [Exporter](https://metacpan.org/pod/Exporter) does.
@@ -212,6 +215,8 @@ to import one of these, Importer will hit your `$from->export_fail(@items)`
callback to try to resolve the issue. See [Exporter.pm](https://metacpan.org/pod/Exporter.pm) for documentation of
this feature.
+ our @EXPORT_FAIL = qw/maybe_bad/;
+
## %EXPORT\_ANON
This is new to this module, [Exporter](https://metacpan.org/pod/Exporter) does not support it.
@@ -315,8 +320,10 @@ to support Importer by putting this sub in your package:
return $ref;
}
-All exports must be listed in either `@EXPORT` or `@EXPORT_OK` to be allowed.
-`%EXPORT_TAGS`, `@EXPORT_FAIL`, and `\&GENERATE` are optional.
+All exports must be listed in either `@EXPORT` or `@EXPORT_OK`, or be keys in
+`%EXPORT_GEN` or `%EXPORT_ANON` to be allowed. 'export\_tags', 'export\_fail',
+'export\_anon', 'export\_gen', and 'generate' are optional. You cannot combine
+'generate' and 'export\_gen'.
**Note:** If your GENERATE sub needs the `$class`, `$into`, or `$caller` then
your `IMPORTER_MENU()` method will need to build an anonymous sub that closes