pydsc pydsc is a Python documentation spell checker.
Download

pydsc Ranking & Summary

pydsc Tags

Python library Python spell checker documentation Python documentation pydsc

pydsc Description

pydsc is a Python documentation spell checker. pydsc is a Python documentation spell checker. This module check Python documentation string for spellilng errors.Requirements:· PythonThe pydsc module contains functionality needed to check documentation strings and comments for spelling errors, within Python code. The pydsc module depends on PyEnchant spell checker. PyEnchant provides interface for different spellengines:· ispell· aspell· OpenOfficeThe use of the pydsc module is very simple - just import pydsc and all modules that will be imported after it will be checked. By default all spelling errors will be printed to sys.stdout. The pydsc checker could be customized in many different ways:· you can define set of files/directories that should be included/excluded from check process· you can redefine error messages destination· you can redefine and/or re-configurate spell checkerInstall:python setup.py installUsage example:import pydscimport readline #errors will be printed to standart outputmore complex example ( taken from pygccxml project ):import pydsc#test only pygccxml#package_directory defined earlierpydsc.doc_checker.filter.append( package_directory )pydsc.doc_checker.filter_type = pydsc.FILTER_TYPE.INCLUDE#map( pydsc.doc_checker.speller.ignore_always , )What's New in This Release:· A few critical bugs were fixed.· The API has been improved.· A few convenience method were added.

pydsc Related Software