Skip to content
  • Stephen Kelly's avatar
    Help: Fix some erroneous code block markers in Module docs. · efc43cde
    Stephen Kelly authored and Brad King's avatar Brad King committed
    There are many style errors in these files. This patch fixes only
    the syntactical errors.
    
    The script which ported these to rst tripped on some incorrectly
    formatted blocks in the original input documentation.  Use a new
    script to find problematic code (and then fix them manually):
    
      #!/usr/bin/env python
    
      import os
    
      rootDir = '.'
    
      def checkFile(fname):
    
        f = open(fname)
        lines = f.readlines()
        started = False
        counter = 0
        for l in lines:
          if "#" in l:
            started = True
          elif started:
            return
          lin = l.find("(")
          if lin != -1 and l.find(")", lin) == -1 and \
              not "(To distribute this file outside of CMake, substitute the full" in l:
            for lp in lines[counter+1:]:
              if lp == "# ::\n":
                print "\n\n######### " + fname + "\n\n"
                print ''.join(lines[max(counter-2, 0):counter+6])
                break
              elif lp == "#\n" :
                continue
              break
          counter += 1
    
      for dirName, subdirList, fileList in os.walk(rootDir):
          for fname in fileList:
              checkFile(os.path.join(dirName, fname))
    efc43cde