Skip to content

Commit

Permalink
document pod use in nqp
Browse files Browse the repository at this point in the history
  • Loading branch information
tbrowder committed Jan 23, 2018
1 parent bbaa5a5 commit 86e062e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/using-pod-in-nqp.md
@@ -0,0 +1,21 @@
## Using POD in NQP

Limited pod use is acceptable in nqp files. The following forms are currently allowed:

### Single-line entries

=identifier ...text... # note that use of 'cut' as an identifier will cause a panic

Any word (other than 'cut' is accepted). The entry may be used inside a pod block.

### Blocks

=begin ...optional identifier... ...optional text...
...any text
=end ...optional identifier...

If the **=begin** has an identifier, the **=end** should have the same identifier (not
yet enforced).



0 comments on commit 86e062e

Please sign in to comment.