rfctr: change param ref from asterisk to backticks · python-openxml/python-docx@e88e1d5 · GitHub
Skip to content

Commit e88e1d5

Browse files
scannyscanny
committed
rfctr: change param ref from asterisk to backticks
Sphinx handling is actually better, not only using italic but also a mono-width font.
1 parent cbf940c commit e88e1d5

74 files changed

Lines changed: 428 additions & 428 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/document.rst‎

Lines changed: 15 additions & 15 deletions

‎docs/api/shared.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ allowing values to be expressed in the units most appropriate to the context.
5252
:members:
5353
:undoc-members:
5454

55-
*r*, *g*, and *b* are each an integer in the range 0-255 inclusive. Using
55+
`r`, `g`, and `b` are each an integer in the range 0-255 inclusive. Using
5656
the hexidecimal integer notation, e.g. `0x42` may enhance readability
5757
where hex RGB values are in use::
5858

‎docs/dev/analysis/features/header.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ a section title or page number. Such a header is also known as a running head.
1010

1111
A page footer is analogous in every way to a page header except that it appears at the
1212
bottom of a page. It should not be confused with a footnote, which is not uniform
13-
between pages. For brevity's sake, the term *header* is often used here to refer to what
13+
between pages. For brevity's sake, the term `header` is often used here to refer to what
1414
may be either a header or footer object, trusting the reader to understand its
1515
applicability to both object types.
1616

1717
In book-printed documents, where pages are printed on both sides, when opened, the front
18-
or *recto* side of each page appears to the right of the bound edge and the back or
19-
*verso* side of each page appears on the left. The first printed page receives the
18+
or `recto` side of each page appears to the right of the bound edge and the back or
19+
`verso` side of each page appears on the left. The first printed page receives the
2020
page-number "1", and is always a recto page. Because pages are numbered consecutively,
21-
each recto page receives an *odd* page number and each verso page receives an *even*
21+
each recto page receives an `odd` page number and each verso page receives an `even`
2222
page number.
2323

2424
The header appearing on a recto page often differs from that on a verso page. Supporting

‎docs/dev/analysis/features/sections.rst‎

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

5-
Word supports the notion of a *section*, having distinct page layout settings.
5+
Word supports the notion of a `section`, having distinct page layout settings.
66
This is how, for example, a document can contain some pages in portrait layout
77
and others in landscape. Section breaks are implemented completely differently
88
from line, page, and column breaks. The former adds a ``<w:pPr><w:sectPr>``

‎docs/dev/analysis/features/shapes/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
Shapes (in general)
33
===================
44

5-
A graphical object that appears in a Word document is known as a *shape*.
6-
A shape can be *inline* or *floating*. An inline shape appears on a text
5+
A graphical object that appears in a Word document is known as a `shape`.
6+
A shape can be `inline` or `floating`. An inline shape appears on a text
77
baseline as though it were a character glyph and affects the line height.
88
A floating shape appears at an arbitrary location on the document and text may
99
wrap around it. Several types of shape can be placed, including a picture, a

‎docs/dev/analysis/features/styles/character-style.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ A baseline regular run::
6262
</w:r>
6363
</w:p>
6464

65-
Adding *Emphasis* character style::
65+
Adding `Emphasis` character style::
6666

6767
<w:p>
6868
<w:r>

‎docs/dev/analysis/features/styles/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Styles
1111
character-style
1212
latent-styles
1313

14-
Word supports the definition of *styles* to allow a group of formatting
14+
Word supports the definition of `styles` to allow a group of formatting
1515
properties to be easily and consistently applied to a paragraph, run, table,
1616
or numbering scheme, all at once. The mechanism is similar to how Cascading
1717
Style Sheets (CSS) works with HTML.

‎docs/dev/analysis/features/styles/latent-styles.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ The `w:latentStyles` element used in the default Word 2011 template::
132132
Latent style behavior
133133
---------------------
134134

135-
* A style has two categories of attribute, *behavioral* and *formatting*.
135+
* A style has two categories of attribute, `behavioral` and `formatting`.
136136
Behavioral attributes specify where and when the style should appear in the
137137
user interface. Behavioral attributes can be specified for latent styles
138138
using the ``<w:latentStyles>`` element and its ``<w:lsdException>`` child
@@ -157,14 +157,14 @@ Latent style behavior
157157
value is 0 if not specified.
158158

159159
* **semiHidden**. The `semiHidden` attribute causes the style to be excluded
160-
from the recommended list. The notion of *semi* in this context is that
160+
from the recommended list. The notion of `semi` in this context is that
161161
while the style is hidden from the recommended list, it still appears in
162162
the "All Styles" list. This attribute is removed on first application of
163163
the style if an `unhideWhenUsed` attribute set |True| is also present.
164164

165165
* **unhideWhenUsed**. The `unhideWhenUsed` attribute causes any `semiHidden`
166166
attribute to be removed when the style is first applied to content. Word
167-
does *not* remove the `semiHidden` attribute just because there exists an
167+
does `not` remove the `semiHidden` attribute just because there exists an
168168
object in the document having that style. The `unhideWhenUsed` attribute is
169169
not removed along with the `semiHidden` attribute when the style is
170170
applied.

‎docs/dev/analysis/features/styles/style.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ There are six behavior properties:
1616

1717
hidden
1818
Style operates to assign formatting properties, but does not appear in
19-
the UI under any circumstances. Used for *internal* styles assigned by an
19+
the UI under any circumstances. Used for `internal` styles assigned by an
2020
application that should not be under the control of an end-user.
2121

2222
priority
@@ -98,10 +98,10 @@ semi-hidden
9898
-----------
9999

100100
The `w:semiHidden` element specifies visibility of the style in the so-called
101-
*main* user interface. For Word, this means the style gallery and the
101+
`main` user interface. For Word, this means the style gallery and the
102102
recommended, styles-in-use, and in-current-document lists. The all-styles
103103
list and current-style dropdown in the styles pane would then be considered
104-
part of an *advanced* user interface.
104+
part of an `advanced` user interface.
105105

106106
Behavior
107107
~~~~~~~~

‎docs/dev/analysis/features/table/table-props.rst‎

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)