fix: small documentation fixes

scanny · scanny · commit c1b7682ebd2e · 2018-08-18T10:33:21.000-07:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -371,4 +371,4 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {'http://docs.python.org/3/': None}
diff --git a/docs/dev/analysis/features/styles/style.rst b/docs/dev/analysis/features/styles/style.rst
@@ -182,6 +182,8 @@ contents does not cause the `w:semiHidden` element to be removed.
 Candidate protocol
 ~~~~~~~~~~~~~~~~~~
 
+.. highlight:: python
+
 ::
 
     >>> style = document.styles['Foo']
@@ -243,6 +245,8 @@ will appear in the gallery in the order specified by `w:uiPriority`.
 Candidate protocol
 ~~~~~~~~~~~~~~~~~~
 
+.. highlight:: python
+
 ::
 
     >>> style = document.styles['Foo']
@@ -300,6 +304,8 @@ Behavior
 Candidate protocol
 ~~~~~~~~~~~~~~~~~~
 
+.. highlight:: python
+
 ::
 
     >>> style = document.styles['Foo']
@@ -344,6 +350,8 @@ used when writing XML::
 Candidate protocols
 -------------------
 
+.. highlight:: python
+
 Identification::
 
     >>> style = document.styles['Body Text']
@@ -385,7 +393,7 @@ Example XML
 
   <w:styles>
 
-    <!-- ... -->   
+    <!-- ... -->
 
     <w:style w:type="paragraph" w:default="1" w:styleId="Normal">
       <w:name w:val="Normal"/>
diff --git a/docs/dev/analysis/features/table/cell-merge.rst b/docs/dev/analysis/features/table/cell-merge.rst
@@ -60,8 +60,8 @@ Basic merge protocol
 A merge is specified using two diagonal cells::
 
     >>> table = document.add_table(3, 3)
-    >>> a = table.cells(0, 0)
-    >>> b = table.cells(1, 1)
+    >>> a = table.cell(0, 0)
+    >>> b = table.cell(1, 1)
     >>> A = a.merge(b)
 
 ::
diff --git a/docs/index.rst b/docs/index.rst
@@ -31,13 +31,13 @@ Here's an example of what |docx| can do:
                                                 p.add_run('italic.').italic = True
 
                                                 document.add_heading('Heading, level 1', level=1)
-                                                document.add_paragraph('Intense quote', style='IntenseQuote')
+                                                document.add_paragraph('Intense quote', style='Intense Quote')
 
                                                 document.add_paragraph(
-                                                    'first item in unordered list', style='ListBullet'
+                                                    'first item in unordered list', style='List Bullet'
                                                 )
                                                 document.add_paragraph(
-                                                    'first item in ordered list', style='ListNumber'
+                                                    'first item in ordered list', style='List Number'
                                                 )
 
                                                 document.add_picture('monty-truth.png', width=Inches(1.25))
diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst
@@ -132,7 +132,7 @@ the sequence::
 You can also add rows to a table incrementally like so::
 
     row = table.add_row()
-    
+
 This can be very handy for the variable length table scenario we mentioned
 above::
 
@@ -282,14 +282,14 @@ Note that you can set bold or italic right on the result of ``.add_run()`` if
 you don't need it for anything else::
 
     paragraph.add_run('dolor').bold = True
-    
+
     # is equivalent to:
 
     run = paragraph.add_run('dolor')
     run.bold = True
 
     # except you don't have a reference to `run` afterward
-    
+
 
 It's not necessary to provide text to the ``.add_paragraph()`` method. This can
 make your code simpler if you're building the paragraph up from runs anyway::
@@ -298,7 +298,7 @@ make your code simpler if you're building the paragraph up from runs anyway::
     paragraph.add_run('Lorem ipsum ')
     paragraph.add_run('dolor').bold = True
     paragraph.add_run(' sit amet.')
- 
+
 
 Applying a character style
 --------------------------
diff --git a/docs/user/sections.rst b/docs/user/sections.rst
@@ -98,7 +98,7 @@ from portrait to landscape::
     >>> section.page_width = new_width
     >>> section.page_height = new_height
     >>> section.orientation, section.page_width, section.page_height
-    (LANDSCAPE (1), 10058400, 7772400) 
+    (LANDSCAPE (1), 10058400, 7772400)
 
 
 Page margins

Original file line number	Diff line number	Diff line change
`@@ -371,4 +371,4 @@`
`371`	`371`
`372`	`372`
`373`	`373`	`# Example configuration for intersphinx: refer to the Python standard library.`
`374`		`-intersphinx_mapping = {'http://docs.python.org/': None}`
	`374`	`+intersphinx_mapping = {'http://docs.python.org/3/': None}`
Original file line number	Diff line number	Diff line change
`@@ -31,13 +31,13 @@ Here's an example of what \|docx\| can do:`
`31`	`31`	`p.add_run('italic.').italic = True`
`32`	`32`
`33`	`33`	`document.add_heading('Heading, level 1', level=1)`
`34`		`- document.add_paragraph('Intense quote', style='IntenseQuote')`
	`34`	`+ document.add_paragraph('Intense quote', style='Intense Quote')`
`35`	`35`
`36`	`36`	`document.add_paragraph(`
`37`		`- 'first item in unordered list', style='ListBullet'`
	`37`	`+ 'first item in unordered list', style='List Bullet'`
`38`	`38`	`)`
`39`	`39`	`document.add_paragraph(`
`40`		`- 'first item in ordered list', style='ListNumber'`
	`40`	`+ 'first item in ordered list', style='List Number'`
`41`	`41`	`)`
`42`	`42`
`43`	`43`	`document.add_picture('monty-truth.png', width=Inches(1.25))`