Skip to content

Commit 89ed86f

Browse files
committed
whitespace and text reflow
documention -> documentation
1 parent 566febe commit 89ed86f

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ Your patches to perl6/doc are very welcome.
55
This document describes how to get started and helps to provide documentation
66
that adheres to the common style and formatting guidelines.
77

8-
Your contributions here will be credited in the next Rakudo release announcement. Your name from
9-
the commit log will be used. If you'd like to be credited under a different name,
10-
please add it to the local
11-
[CREDITS](CREDITS)
8+
Your contributions here will be credited in the next Rakudo release
9+
announcement. Your name from the commit log will be used. If you'd like to be
10+
credited under a different name, please add it to the local [CREDITS](CREDITS)
1211
file (or ask someone to do it for you until you have commit privileges).
1312

1413
If you have any questions regarding contributing to this project, please ask
@@ -45,17 +44,17 @@ in the [#perl6 IRC channel](https://perl6.org/community/irc).
4544
* Be explicit about routine signatures. If a method accepts an `*%args`,
4645
but treats some of them specially, list them separately.
4746
* Check out [the styleguide](writing-docs/STYLEGUIDE.md) for further guidance.
48-
* If you are participating in one of the monthly
49-
squashathons,
47+
* If you are participating in one of the monthly squashathons,
5048
[please read this guide](writing-docs/SQUASHATHONS.md).
5149

5250
## Documenting versions
5351

54-
* If you are adding a recently introduced feature, please indicate in a note which version it was introduced in.
52+
* If you are adding a recently introduced feature, please indicate in a note
53+
which version it was introduced in.
5554
* If you change an example to use the new feature, leave the old
56-
example if it's still working, at least while it's not obsolete, for people who have not
57-
upgraded yet, clarifying in the text around it the versions it will
58-
run with.
55+
example if it's still working, at least while it's not obsolete, for people
56+
who have not upgraded yet, clarifying in the text around it the versions it
57+
will run with.
5958

6059
## Writing Code Examples
6160

@@ -64,9 +63,9 @@ available when writing code examples in the documentation.
6463

6564
## Adding a new Language document
6665

67-
We suggest you discuss proposing a new Language document on the #perl6 channel before
68-
you proceed further. After you get consensus on a title, subtitle, section, and
69-
filename, you can add the document by following these steps:
66+
We suggest you discuss proposing a new Language document on the #perl6 channel
67+
before you proceed further. After you get consensus on a title, subtitle,
68+
section, and filename, you can add the document by following these steps:
7069

7170
+ create a **filename.pod6** file in the **doc/Language** directory and
7271
ensure it adheres to the conventions in
@@ -82,7 +81,7 @@ The Pod 6 documentation of types is located in the `doc/Type` directory and
8281
subdirectories of this repository. For example the Pod 6 file of `X::Bind::Slice`
8382
lives in `doc/Type/X/Bind/Slice.pod6`.
8483

85-
To start contributing fork and checkout the repository, find the document
84+
To start contributing, fork and checkout the repository, find the document
8685
you want to improve, commit your changes, and create a pull request. Should
8786
questions come up in the process feel free to ask in
8887
[#perl6 IRC channel](https://perl6.org/community/irc).
@@ -120,7 +119,7 @@ When documenting a pair of a sub and a method with the same functionality, the
120119
heading should be `=head2 routine do-it`, and the next thing should be two or
121120
more lines with the signatures. Other allowed words instead of `method` are
122121
`sub`, `trait`, `infix`, `prefix`, `postfix`, `circumfix`, `postcircumfix`,
123-
`term`. If you wish to hide a heading from any index prefix it with the empty
122+
`term`. If you wish to hide a heading from any index, prefix it with the empty
124123
comment `Z<>`.
125124

126125
When providing a code example result or output, use this style:
@@ -154,8 +153,8 @@ See [Writing and Testing Examples](writing-docs/EXAMPLES.md)
154153

155154
## Testing method completeness
156155

157-
To get a list of methods that are found via introspection but not
158-
found in any Pod 6 file under `doc/Type/`, use `util/list-missing-methods.p6`. It takes a
156+
To get a list of methods that are found via introspection but not found in any
157+
Pod 6 file under `doc/Type/`, use `util/list-missing-methods.p6`. It takes a
159158
directory or filepath as argument and limits the listing to the given file or
160159
any Pod 6-files found. All methods listed in `util/ignored-methods.txt` are
161160
ignored.
@@ -167,7 +166,7 @@ the page to activate debug mode. The state of debug mode will be remembered by
167166
`window.sessionStorage` and will not survive a browser restart or opening the
168167
docs in a new tab.
169168

170-
q### Invisible index anchors
169+
### Invisible index anchors
171170

172171
You can create index entries and invisible anchors with `X<|thing,category>`.
173172
To make them visible activate debug mode.
@@ -207,7 +206,7 @@ If you would like to contribute documentation or other bug fixes, please use
207206
Assuming that you have already forked and cloned the
208207
[perl6/doc](https://github.com/perl6/doc) repository, one of the first things
209208
you probably want to do is to build the documentation on your local
210-
computer. To do this you will need:
209+
computer. To do this you will need:
211210

212211
- Perl 6 (e.g., the Rakudo Perl 6 implementation)
213212
- zef (the installer for third party Perl 6 modules)
@@ -290,7 +289,7 @@ To actually build the documentation all you now need to do is run:
290289
This takes a while, but be patient!
291290

292291
After the build has completed, you can start the web application which will
293-
render the HTML documention on a web server on your build host:
292+
render the HTML documentation on a web server on your build host:
294293

295294
$ make run
296295

@@ -299,12 +298,14 @@ documentation.
299298

300299
#### Using Docker to build and view the documentation
301300

302-
You can skip all the above and just build and view documentation with these simple commands (if you have docker already installed):
301+
You can skip all the above and just build and view documentation with these
302+
simple commands (if you have docker already installed):
303303

304304
$ docker build -t perl6-doc .
305305
$ docker run -p 3000:3000 -it -v `pwd`:/perl6/doc perl6-doc
306306

307-
This will build the documentation for you by default and it will take some time, but for subsequent use you may want to skip build part if nothing has been changed:
307+
This will build the documentation for you by default and it will take some time,
308+
but for subsequent use you may want to skip build part if nothing has been changed:
308309

309310
$ docker run -p 3000:3000 -it -v `pwd`:/perl6/doc perl6-doc ./app-start
310311

@@ -322,14 +323,14 @@ To run the development web server for viewing documentation (on port 3000):
322323

323324
$ make docker-run
324325

325-
Note that while this requires less typing, some assumptions will be made for you regarding the name
326-
of the resulting image, the port the content is available over, etc. If you want, you can
327-
override these default values.
326+
Note that while this requires less typing, some assumptions will be made for
327+
you regarding the name of the resulting image, the port the content is available
328+
over, etc. If you want, you can override these default values.
328329

329-
For instance, if you want the local documentation to be available over port 5001 of the host,
330-
pass the following to make when running:
330+
For instance, if you want the local documentation to be available over port 5001
331+
of the host, pass the following to make when running:
331332

332333
$ make docker-run DOCKER_HOST_PORT=5001
333334

334-
Now the documentation will be available on the host at http://localhost:5001. Please see the
335-
Makefile for a list of available options.
335+
Now the documentation will be available on the host at http://localhost:5001.
336+
Please see the Makefile for a list of available options.

0 commit comments

Comments
 (0)