def isignored()

in shelldocs/src/main/python/shelldocs.py [0:0]


    def isignored(self):
        """Checks for the presence of the marker(SHELLDOC-IGNORE) to ignore the file.

      Marker needs to be in a line of its own and can not
      be an inline comment.

      A leading '#' and white-spaces(leading or trailing)
      are trimmed before checking equality.

      Comparison is case sensitive and the comment must be in
      UPPERCASE.
      """
        with open(self.filename) as input_file:  #pylint: disable=unspecified-encoding
            for line in input_file:
                if line.startswith(
                        "#") and line[1:].strip() == "SHELLDOC-IGNORE":
                    return True
            return False