Skip to content

Commit

Permalink
Test .md files for Perl 5|6 nbsp
Browse files Browse the repository at this point in the history
Fix all instances in the md docs
  • Loading branch information
coke committed Apr 12, 2018
1 parent 2ef1365 commit 1cdd22f
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 30 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Expand Up @@ -189,7 +189,7 @@ computer. To do this you will need:
- `Pod::To::HTML` (Perl 6 module for converting Pod objects to HTML)
- [graphviz](http://www.graphviz.org/) (`sudo apt-get install graphviz` on Debian/Ubuntu)
- [Mojolicious](https://metacpan.org/pod/Mojolicious)
(optional; a Perl 5 web framework; it allows you to run a web
(optional; a Perl 5 web framework; it allows you to run a web
app locally to display the docs)
- [SASS](http://sass-lang.com/) Compiler
- [highlights](https://github.com/perl6/atom-language-perl6) (optional; requires
Expand Down Expand Up @@ -223,15 +223,15 @@ You'll also need `Pod::To::BigPage`. Install these modules like so:

#### Mojolicious / Web Server

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

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

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

Expand All @@ -244,7 +244,7 @@ the `sass` command

$ sudo apt-get install ruby-sass

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

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

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

$ perl app.pl daemon # note! Perl 5 *not* Perl 6 here
$ perl app.pl daemon # note! Perl 5 *not* Perl 6 here

Now point your web browser to http://localhost:3000 to view the
documentation.
Expand Down
16 changes: 8 additions & 8 deletions README.md
@@ -1,4 +1,4 @@
# Official Perl 6 Documentation
# Official Perl 6 Documentation

[![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)

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

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

## README in other languages

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

## Install p6doc

This module is available via the Perl 6 module ecosystem. Use
This module is available via the Perl 6 module ecosystem. Use

zef install p6doc

Expand Down Expand Up @@ -55,7 +55,7 @@ following, to update the shims for installed executables:

rakudobrew rehash

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

sudo apt-get install graphviz
Expand Down Expand Up @@ -87,7 +87,7 @@ install them all using

## Help Wanted!

Perl 6 is not a small language, and documenting it takes a lot of effort.
Perl 6 is not a small language, and documenting it takes a lot of effort.
Any help is appreciated.

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

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

> I want p6doc and doc.perl6.org to become the No. 1 resource to consult
> when you want to know something about a Perl 6 feature, be it from the
> when you want to know something about a Perl 6 feature, be it from the
> language, or built-in types and routines. I want it to be useful to every
> Perl 6 programmer.
> Perl 6 programmer.
>
> -- moritz
Expand Down
18 changes: 9 additions & 9 deletions README.zh.md
@@ -1,4 +1,4 @@
# Perl 6 官方文档 【意译】
# Perl 6 官方文档 【意译】

[![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)

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

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

## 其他语言README

[English README](README.md)

## 安装 p6doc

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

zef install p6doc

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

rakudobrew rehash

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

sudo apt-get install graphviz

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

## 希望得到帮助!

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

一些帮助我们的方式:

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

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

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

## Wishlist stuff:

* Perl 6 implementations could embed `P<...>` tags in their source
* Perl 6 implementations could embed `P<...>` tags in their source
code that would then inline the corresponding entry from `p6doc`.
This would enable things like `&say.WHY` to (dynamically!)
retrieve the documentation string from `p6doc`, without having
Expand Down
14 changes: 7 additions & 7 deletions writing-docs/STYLEGUIDE.md
Expand Up @@ -53,7 +53,7 @@ For examples where a particular format is required, or exact data is expected
* Argument: what it looks like to the caller
* Parameter: what it looks like to the function

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

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

### Use present tense when talking about Perl 5 features
### Use present tense when talking about Perl 5 features

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

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

## Perl 5 and Perl 6

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

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

### Use non-breaking spaces when dealing with Perl version numbers
Expand Down
2 changes: 1 addition & 1 deletion xt/perl-nbsp.t
Expand Up @@ -5,7 +5,7 @@ use Test;
use lib 'lib';
use Test-Files;

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

plan +@files;

Expand Down

0 comments on commit 1cdd22f

Please sign in to comment.