api: remove old Document.add_heading()

Steve Canny · Steve Canny · commit 3a9523ae8209 · 2015-02-14T17:30:47.000-08:00
diff --git a/docx/api.py b/docx/api.py
@@ -54,18 +54,7 @@ def __init__(self, docx=None):
         self._package = document._part.package
 
     def add_heading(self, text='', level=1):
-        """
-        Return a heading paragraph newly added to the end of the document,
-        containing *text* and having its paragraph style determined by
-        *level*. If *level* is 0, the style is set to `Title`. If *level* is
-        1 (or omitted), `Heading 1` is used. Otherwise the style is set to
-        `Heading {level}`. Raises |ValueError| if *level* is outside the
-        range 0-9.
-        """
-        if not 0 <= level <= 9:
-            raise ValueError("level must be in range 0-9, got %d" % level)
-        style = 'Title' if level == 0 else 'Heading %d' % level
-        return self.add_paragraph(text, style)
+        return self._document.add_heading(text, level)
 
     def add_page_break(self):
         """
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -27,7 +27,7 @@
 from docx.text.run import Run
 
 from .unitutil.mock import (
-    function_mock, instance_mock, class_mock, method_mock, property_mock
+    function_mock, instance_mock, class_mock, property_mock
 )
 
 
@@ -92,18 +92,6 @@ def Package_(self, request):
 
 class DescribeDocumentOld(object):
 
-    def it_can_add_a_heading(self, add_heading_fixture):
-        document, text, level, style, paragraph_ = add_heading_fixture
-        paragraph = document.add_heading(text, level)
-        document.add_paragraph.assert_called_once_with(text, style)
-        assert paragraph is paragraph_
-
-    def it_should_raise_on_heading_level_out_of_range(self, document):
-        with pytest.raises(ValueError):
-            document.add_heading(level=-1)
-        with pytest.raises(ValueError):
-            document.add_heading(level=10)
-
     def it_can_add_a_page_break(self, add_page_break_fixture):
         document, document_part_, paragraph_, run_ = add_page_break_fixture
         paragraph = document.add_page_break()
@@ -189,18 +177,6 @@ def it_creates_numbering_part_on_first_access_if_not_present(
 
     # fixtures -------------------------------------------------------
 
-    @pytest.fixture(params=[
-        (0, 'Title'),
-        (1, 'Heading 1'),
-        (2, 'Heading 2'),
-        (9, 'Heading 9'),
-    ])
-    def add_heading_fixture(self, request, document, add_paragraph_,
-                            paragraph_):
-        level, style = request.param
-        text = 'Spam vs. Bacon'
-        return document, text, level, style, paragraph_
-
     @pytest.fixture
     def add_page_break_fixture(
             self, document, document_part_, paragraph_, run_):
@@ -260,12 +236,6 @@ def tables_fixture(self, document, tables_):
 
     # fixture components ---------------------------------------------
 
-    @pytest.fixture
-    def add_paragraph_(self, request, paragraph_):
-        return method_mock(
-            request, Document, 'add_paragraph', return_value=paragraph_
-        )
-
     @pytest.fixture
     def core_properties_(self, request):
         return instance_mock(request, CoreProperties)
