Skip to content

Commit 5195478

Browse files
committed
rST documentation fixup.
Fix path of help file in leading comment. Remove trailing whitespace. Wrap long line. Update metadata.
1 parent 7a3af3e commit 5195478

File tree

3 files changed

+19
-16
lines changed

3 files changed

+19
-16
lines changed

docs/user/rest.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ reST (reStructuredText) Markup
33
===============================
44

55
..
6-
This document is duplicated within Moin2 as `/docs/user/rest.rst` and
7-
`contrib/sample/rst.data`. Please update both.
6+
This document is duplicated within the Moin2 repository as
7+
`docs/user/rest.rst` and `src/moin/help/help-en/rst.data`.
8+
Please update both.
89
910
Depending on your source, this document may have been created by
1011
the Moin2 reST parser (Docutils) or the Sphinx reST parser. These parsers
@@ -96,11 +97,11 @@ The following is a table of inline markup that can be used to format text in Moi
9697
Markup Result
9798
======================================== ====================================
9899
``**Bold Text**`` **Bold text**
99-
100+
100101
``*Italic*`` *Italic*
101-
102+
102103
````Inline Literals```` ``Inline Literals``
103-
104+
104105
``***nested markup is not supported***`` ***nested markup is not supported***
105106
======================================== ====================================
106107

@@ -127,7 +128,8 @@ Markup Result
127128
Internal Links
128129
--------------
129130

130-
The examples below use the "help-en" and "help-common" namespaces to separate these help pages from the main wiki content.
131+
The examples below use the "help-en" and "help-common" namespaces
132+
to separate these help pages from the main wiki content.
131133
Some target pages may be missing from the default namespace.
132134

133135
Within the rst syntax:

src/moin/help/help-en/rst.data

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ reST (reStructuredText) Markup
33
===============================
44

55
..
6-
This document is duplicated within Moin2 as `/docs/user/rest.rst` and
7-
`contrib/sample/rst.data`. Please update both.
6+
This document is duplicated within the Moin2 repository as
7+
`docs/user/rest.rst` and `src/moin/help/help-en/rst.data`.
8+
Please update both.
89

910
Depending on your source, this document may have been created by
1011
the Moin2 reST parser (Docutils) or the Sphinx reST parser. These parsers
@@ -96,11 +97,11 @@ The following is a table of inline markup that can be used to format text in Moi
9697
Markup Result
9798
======================================== ====================================
9899
``**Bold Text**`` **Bold text**
99-
100+
100101
``*Italic*`` *Italic*
101-
102+
102103
````Inline Literals```` ``Inline Literals``
103-
104+
104105
``***nested markup is not supported***`` ***nested markup is not supported***
105106
======================================== ====================================
106107

@@ -127,7 +128,7 @@ Markup Result
127128
Internal Links
128129
--------------
129130

130-
The examples below use the "help-en" and "help-common" namespaces
131+
The examples below use the "help-en" and "help-common" namespaces
131132
to separate these help pages from the main wiki content.
132133
Some target pages may be missing from the default namespace.
133134

src/moin/help/help-en/rst.meta

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
"contenttype": "text/x-rst;charset=utf-8",
66
"dataid": "c7f47fd6eaaa4e518c2bd32d741073f8",
77
"externallinks": [
8-
"http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#enumerated-lists",
98
"http://moinmo.in/",
10-
"http://www.python.org/"
9+
"http://www.python.org/",
10+
"https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#enumerated-lists"
1111
],
1212
"itemid": "412d0e59c79147058ef2e947d1772d5f",
1313
"itemlinks": [
@@ -29,8 +29,8 @@
2929
"namespace": "help-en",
3030
"rev_number": 1,
3131
"revid": "fd40283c31464441a3734ba512b7cfb0",
32-
"sha1": "40abb7437b6bd5234f58644114cef02eaa7a7b83",
33-
"size": 21443,
32+
"sha1": "d71e4e1f1e978714550ab1c0f80033cc3d3e182c",
33+
"size": 19176,
3434
"summary": "",
3535
"tags": [
3636
"parser",

0 commit comments

Comments
 (0)