Skip to content

Commit 1cdd22f

Browse files
committed
Test .md files for Perl 5|6 nbsp
Fix all instances in the md docs
1 parent 2ef1365 commit 1cdd22f

File tree

5 files changed

+30
-30
lines changed

5 files changed

+30
-30
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ computer. To do this you will need:
189189
- `Pod::To::HTML` (Perl 6 module for converting Pod objects to HTML)
190190
- [graphviz](http://www.graphviz.org/) (`sudo apt-get install graphviz` on Debian/Ubuntu)
191191
- [Mojolicious](https://metacpan.org/pod/Mojolicious)
192-
(optional; a Perl 5 web framework; it allows you to run a web
192+
(optional; a Perl 5 web framework; it allows you to run a web
193193
app locally to display the docs)
194194
- [SASS](http://sass-lang.com/) Compiler
195195
- [highlights](https://github.com/perl6/atom-language-perl6) (optional; requires
@@ -223,15 +223,15 @@ You'll also need `Pod::To::BigPage`. Install these modules like so:
223223

224224
#### Mojolicious / Web Server
225225

226-
This is a Perl 5 web framework which is used to run the included
226+
This is a Perl 5 web framework which is used to run the included
227227
web application that displays the HTML documentation in a web browser. It's
228228
no required for development, as the site is static and you can serve it using
229229
any other webserver.
230230

231231
The app *does* automatically convert the SASS file to CSS, so it's handy to
232232
use for that as well.
233233

234-
Mojolicious is written in Perl 5, so assuming that you use
234+
Mojolicious is written in Perl 5, so assuming that you use
235235
[`cpanm`](https://metacpan.org/pod/App::cpanminus),
236236
install this now:
237237

@@ -244,7 +244,7 @@ the `sass` command
244244

245245
$ sudo apt-get install ruby-sass
246246

247-
or the [CSS::Sass Perl 5 module](https://modules.perl6.org/repo/CSS::Sass)
247+
or the [CSS::Sass Perl 5 module](https://modules.perl6.org/repo/CSS::Sass)
248248

249249
$ cpanm -vn CSS::Sass Mojolicious::Plugin::AssetPack
250250

@@ -263,7 +263,7 @@ This takes a while, but be patient!
263263
After the build has completed, you can start the web application which will
264264
render the HTML documentation
265265

266-
$ perl app.pl daemon # note! Perl 5 *not* Perl 6 here
266+
$ perl app.pl daemon # note! Perl 5 *not* Perl 6 here
267267

268268
Now point your web browser to http://localhost:3000 to view the
269269
documentation.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Official Perl 6 Documentation
1+
# Official Perl 6 Documentation
22

33
[![Build Status](https://travis-ci.org/perl6/doc.svg?branch=master)](https://travis-ci.org/perl6/doc) [![artistic](https://img.shields.io/badge/license-Artistic%202.0-blue.svg?style=flat)](https://opensource.org/licenses/Artistic-2.0)
44

@@ -8,15 +8,15 @@ This is currently the recommended way to consume the documentation.
88
There is also a command line tool called "p6doc".
99

1010
(If you are browsing this repository via GitHub, it will not display most
11-
files correctly, because this is Perl 6 Pod, and GitHub assumes Perl 5 POD).
11+
files correctly, because this is Perl 6 Pod, and GitHub assumes Perl 5 POD).
1212

1313
## README in other languages
1414

1515
* [README in Chinese](README.zh.md).
1616

1717
## Install p6doc
1818

19-
This module is available via the Perl 6 module ecosystem. Use
19+
This module is available via the Perl 6 module ecosystem. Use
2020

2121
zef install p6doc
2222

@@ -55,7 +55,7 @@ following, to update the shims for installed executables:
5555

5656
rakudobrew rehash
5757

58-
In addition to the Perl 6 dependencies, you need to have `graphviz` installed, which
58+
In addition to the Perl 6 dependencies, you need to have `graphviz` installed, which
5959
on Debian you can do by running
6060

6161
sudo apt-get install graphviz
@@ -87,7 +87,7 @@ install them all using
8787

8888
## Help Wanted!
8989

90-
Perl 6 is not a small language, and documenting it takes a lot of effort.
90+
Perl 6 is not a small language, and documenting it takes a lot of effort.
9191
Any help is appreciated.
9292

9393
Here are some ways to help us:
@@ -113,7 +113,7 @@ explains briefly how to get started contributing documentation.
113113

114114
1. This documentation is intended to be universal with
115115
respect to a given version of the specification,
116-
and not necessarily tied to any specific Perl 6
116+
and not necessarily tied to any specific Perl 6
117117
implementation.
118118
2. Implementations' handling of embedded POD is still
119119
a bit uneven; this avoids potential runtime impacts.
@@ -134,9 +134,9 @@ explains briefly how to get started contributing documentation.
134134
## Vision
135135

136136
> I want p6doc and doc.perl6.org to become the No. 1 resource to consult
137-
> when you want to know something about a Perl 6 feature, be it from the
137+
> when you want to know something about a Perl 6 feature, be it from the
138138
> language, or built-in types and routines. I want it to be useful to every
139-
> Perl 6 programmer.
139+
> Perl 6 programmer.
140140
>
141141
> -- moritz
142142

README.zh.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Perl 6 官方文档 【意译】
1+
# Perl 6 官方文档 【意译】
22

33
[![Build Status](https://travis-ci.org/perl6/doc.svg?branch=master)](https://travis-ci.org/perl6/doc) [![artistic](https://img.shields.io/badge/license-Artistic%202.0-blue.svg?style=flat)](https://opensource.org/licenses/Artistic-2.0)
44

@@ -8,15 +8,15 @@ HTML文档 [https://docs.perl6.org/](https://docs.perl6.org/).
88
还有命令行工具 "p6doc"帮助文档.
99

1010
(如果你通过GitHub浏览本数据仓, 大部分文件显示不正确,
11-
缘由是GitHub 把 Perl 6 Pod识别成 Perl 5 POD).
11+
缘由是GitHub 把 Perl 6 Pod识别成 Perl 5 POD).
1212

1313
## 其他语言README
1414

1515
[English README](README.md)
1616

1717
## 安装 p6doc
1818

19-
本模块可通过Perl 6模块生态系统提供. 使用命令
19+
本模块可通过Perl 6模块生态系统提供. 使用命令
2020

2121
zef install p6doc
2222

@@ -51,7 +51,7 @@ HTML文档 [https://docs.perl6.org/](https://docs.perl6.org/).
5151

5252
rakudobrew rehash
5353

54-
此外 Perl 6 的依赖, 需要安装 `graphviz` , 在 Debian 可执行下面命令
54+
此外 Perl 6 的依赖, 需要安装 `graphviz` , 在 Debian 可执行下面命令
5555

5656
sudo apt-get install graphviz
5757

@@ -78,7 +78,7 @@ HTML文档 [https://docs.perl6.org/](https://docs.perl6.org/).
7878

7979
## 希望得到帮助!
8080

81-
Perl 6不是一种小语言,记录它需要付出很大的努力.任何帮助都值得赞赏.
81+
Perl 6不是一种小语言,记录它需要付出很大的努力.任何帮助都值得赞赏.
8282

8383
一些帮助我们的方式:
8484

@@ -100,7 +100,7 @@ Perl 6不是一种小语言,记录它需要付出很大的努力.任何帮助都
100100

101101
1. This documentation is intended to be universal with
102102
respect to a given version of the specification,
103-
and not necessarily tied to any specific Perl 6
103+
and not necessarily tied to any specific Perl 6
104104
implementation.
105105
2. Implementations' handling of embedded POD is still
106106
a bit uneven; this avoids potential runtime impacts.
@@ -121,17 +121,17 @@ Perl 6不是一种小语言,记录它需要付出很大的努力.任何帮助都
121121
## Vision
122122

123123
> I want p6doc and doc.perl6.org to become the No. 1 resource to consult
124-
> when you want to know something about a Perl 6 feature, be it from the
124+
> when you want to know something about a Perl 6 feature, be it from the
125125
> language, or built-in types and routines. I want it to be useful to every
126-
> Perl 6 programmer.
126+
> Perl 6 programmer.
127127
>
128128
> -- moritz
129129
130130
--------
131131

132132
## Wishlist stuff:
133133

134-
* Perl 6 implementations could embed `P<...>` tags in their source
134+
* Perl 6 implementations could embed `P<...>` tags in their source
135135
code that would then inline the corresponding entry from `p6doc`.
136136
This would enable things like `&say.WHY` to (dynamically!)
137137
retrieve the documentation string from `p6doc`, without having

writing-docs/STYLEGUIDE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ For examples where a particular format is required, or exact data is expected
5353
* Argument: what it looks like to the caller
5454
* Parameter: what it looks like to the function
5555

56-
S06: "In Perl 6 culture, we distinguish the terms parameter and argument; a
56+
S06: "In Perl 6 culture, we distinguish the terms parameter and argument; a
5757
parameter is the formal name that will attach to an incoming argument
5858
during the course of execution, while an argument is the actual value that
5959
will be bound to the formal parameter. The process of attaching these
@@ -66,11 +66,11 @@ For examples where a particular format is required, or exact data is expected
6666

6767
You may use `object` for anything you can call methods on, including value objects and type objects. Consider `instance` for defined objects.
6868

69-
### Use present tense when talking about Perl 5 features
69+
### Use present tense when talking about Perl 5 features
7070

71-
Perl 5 is still an active language, therefore instead of
72-
"In Perl 5 this was used for ..., but in Perl 6 ..."
73-
use a form like "In Perl 5 this is used for ..., but in Perl 6 ..."
71+
Perl 5 is still an active language, therefore instead of
72+
"In Perl 5 this was used for ..., but in Perl 6 ..."
73+
use a form like "In Perl 5 this is used for ..., but in Perl 6 ..."
7474
('was' has been made a present 'is').
7575

7676
### Prefer clear and readable variable names
@@ -93,9 +93,9 @@ Using the second form is more idiomatic and avoids confusion with blocks. In fac
9393

9494
## Perl 5 and Perl 6
9595

96-
### Don't reference Perl 5 unless in a 5-to-6 document or related document
96+
### Don't reference Perl 5 unless in a 5-to-6 document or related document
9797

98-
We are not expecting our users to have to know Perl 5 to learn Perl 6, so this
98+
We are not expecting our users to have to know Perl 5 to learn Perl 6, so this
9999
should not be part of the bulk of the documentation.
100100

101101
### Use non-breaking spaces when dealing with Perl version numbers

xt/perl-nbsp.t

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use Test;
55
use lib 'lib';
66
use Test-Files;
77

8-
my @files = Test-Files.files.grep({$_.ends-with: '.pod6'});
8+
my @files = Test-Files.files.grep({$_.ends-with: '.pod6'|'.md'});
99

1010
plan +@files;
1111

0 commit comments

Comments
 (0)