Skip to content

Commit 4cf8a6b

Browse files
committed
pod6-> rakudoc updates
1 parent 449bf62 commit 4cf8a6b

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

writing-docs/CREATING-NEW-DOCS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### A new (or existing) pod6 document currently must adhere to the following conventions:
1+
### A new (or existing) rakudoc document currently must adhere to the following conventions:
22

33
1. it must be valid Raku pod
44
2. the first non-comment or non-empty line must be:

writing-docs/EXAMPLES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ documentation with some example.
88
Please use code blocks to highlight example code; any indented blocks
99
are considered to be code, but you can specify the `=for code` directive, or a
1010
combination of `=begin code` and `=end code` to better control which
11-
blocks are considered. The POD6 directives also allow you to set
11+
blocks are considered. The rakudoc directives also allow you to set
1212
attributes for a block of code.
1313

1414
When using a `=for code` directive or a `=begin code`/`=end code`
@@ -155,7 +155,7 @@ styles.
155155
## Indented text
156156

157157
4-space indented text is formatted as a code block. The indent is *not*
158-
part of the displayed code. It's not possible to add any POD6
158+
part of the displayed code. It's not possible to add any rakudoc
159159
directives on this style.
160160

161161
## =for code
@@ -167,7 +167,7 @@ is indented.
167167
## =begin code / =end code
168168

169169
The enclosed text is treated as code. The indentation level is
170-
relative to the indentation of the POD6 directives.
170+
relative to the indentation of the rakudoc directives.
171171

172172
## Environment Variables
173173

writing-docs/INDEXING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Synopsis
44

5-
A term or a location in a Pod6 document can be indexed so that it is
5+
A term or a location in a rakudoc document can be indexed so that it is
66
possible to create a named reference pointing to it. This can be used
77
to generate a reference in the rendered version of the documentation or
88
implement search function on the website hosting the rendered documentation.

writing-docs/STYLEGUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ spec items are available in.
222222

223223
## Use of HTML
224224

225-
Generally, Pod6 should be more than enough for any
225+
Generally, rakudoc should be more than enough for any
226226
documentation. However, if you need to embed HTML into the
227227
documentation after thinking about it twice, bear in mind that we support
228228
the current and previous major releases of Chrome, Firefox, Edge,

writing-docs/TESTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ failing tests and someone will still review it.
3131
You can run the basic tests against a subset of files with
3232

3333
```
34-
$ TEST_FILES="doc/Language/faq.pod6 doc/Type/Complex.pod6" make test
34+
$ TEST_FILES="doc/Language/faq.rakudoc doc/Type/Complex.rakudoc" make test
3535
```
3636

3737
Or against everything that you haven't committed yet:
@@ -57,7 +57,7 @@ $ util/test-modified.sh
5757
Or to run specific files regardless of their git status:
5858

5959
```
60-
$ TEST_FILES="doc/Language/faq.pod6 doc/Type/Complex.pod6" make xtest
60+
$ TEST_FILES="doc/Language/faq.rakudoc doc/Type/Complex.rakudoc" make xtest
6161
```
6262

6363
If you see some tests are skipped (spelling or signature checks), that's fine.

0 commit comments

Comments
 (0)