Commit 8fd487b3 authored by Andy Boughton's avatar Andy Boughton
Browse files

Fix for issues identified in #114.

parent b67d798a

tools/check.py

+19 −23
Original line number Diff line number Diff line
@@ -141,7 +141,7 @@ class MarkdownValidator(object): 
        for h in missing_headings:

            logging.error("In {0}: "

                          "Header section is missing expected "

                          "row {1}".format(self.filename, h))

                          "row '{1}'".format(self.filename, h))



        return has_hrs and all(test_headers) and only_headers
@@ -371,9 +371,9 @@ class TopicPageValidator(MarkdownValidator): 
        if node_tests is False:

            logging.error(

                "In {0}: "

                "Learning Objectives should not be empty.".format(

                    self.filename))



                "Page should contain a blockquoted section with level 2 "

                "title 'Learning Objectives'. Section should not "

                "be empty.".format(self.filename))

        return node_tests



    def _validate_has_no_headings(self):
@@ -385,17 +385,13 @@ class TopicPageValidator(MarkdownValidator): 
        if len(heading_nodes) == 0:

            return True



        # Individual heading msgs are logged by validate_section_heading_order

        logging.error(

            "In {0}: "

            "The topic page should not have sub-headings "

            "outside of special blocks. "

            "If a topic needs sub-headings, "

            "it should be broken into multiple topics.".format(self.filename))

        for n in heading_nodes:

            logging.warning(

                "In {0}: "

                "The following sub-heading should be removed: {1}".format(

                    self.filename, n.strings[0]))

        return False



    def _run_tests(self):
@@ -436,7 +432,7 @@ class ReferencePageValidator(MarkdownValidator): 
                "In {0}: "

                "Glossary entry '{1}' must have at least two lines- "

                "a term and a definition.".format(

                        glossary_keyword, self.filename))

                    self.filename, glossary_keyword))

            return False



        entry_is_valid = True
@@ -448,7 +444,7 @@ class ReferencePageValidator(MarkdownValidator): 
                        "At glossary entry '{1}' "

                        "First line of definition must "

                        "start with ':    '.".format(

                                glossary_keyword, self.filename))

                            self.filename, glossary_keyword))

                    entry_is_valid = False

            elif line_index > 1:

                if not re.match("^    ", line):
@@ -457,7 +453,7 @@ class ReferencePageValidator(MarkdownValidator): 
                        "At glossary entry '{1}' "

                        "Subsequent lines of definition must "

                        "start with '     '.".format(

                                glossary_keyword, self.filename))

                            self.filename,  glossary_keyword, ))

                    entry_is_valid = False

        return entry_is_valid

tools/test_check.py

+8 −0
Original line number Diff line number Diff line
@@ -295,6 +295,14 @@ minutes: not a number 
---""")

        self.assertFalse(validator._validate_doc_headers())



    def test_topic_page_should_have_no_headings(self):

        """Requirement according to spec; may be relaxed in future"""

        validator = self._create_validator("""

## Heading that should not be present



Some text""")

        self.assertFalse(validator._validate_has_no_headings())



    def test_sample_file_passes_validation(self):

        sample_validator = self.VALIDATOR(self.SAMPLE_FILE)

        res = sample_validator.validate()