Skip to content

Commit

Permalink
add valid and invalid examples
Browse files Browse the repository at this point in the history
  • Loading branch information
tbrowder committed Jul 23, 2018
1 parent febec41 commit 4277945
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion writing-docs/CREATING-NEW-DOCS.md
@@ -1,4 +1,4 @@
A new (or existing) pod6 document currently must adhere to the following conventions:
### A new (or existing) pod6 document currently must adhere to the following conventions:

1. it must be valid Perl 6 pod
2. the first non-comment or non-empty line must be:
Expand All @@ -16,3 +16,28 @@ A new (or existing) pod6 document currently must adhere to the following convent
5. the last non-comment or non-empty line must be:

=end pod
### Valid example:

```
# this is a valid, non-pod comment
=begin pod :my-link<foo> # another comment
=TITLE Working with Perl 6 pod
=SUBTITLE Alice in Wonderland
# ... more vald pod and text
=comment a pod comment # a valid comment
=end pod
# vi or emacs info
```

### Invalid example:

```
=comment a pod commen # this is not a valid comment in this position
=begin pod :my-link<foo> # another comment
=TITLE Working with Perl 6 pod
=SUBTITLE Alic in Wonderland
# ... more vald pod and text
=end pod
# vi or emacs info
```

0 comments on commit 4277945

Please sign in to comment.