What is pydsc?

pydsc - Python documentation string spell checker

What it is useful for?

Well, this project was born to solve real problem - I made a lot of mistakes, when I write source code documentation for my projects. I needed some way to check all the documentation strings. My goal was simplicity + easy customization. I achieved it. Here is example of usage of pydsc:

import pydsc
#every module that will be imported after pydsc will be checked
#all errors will be printed to stdout
import readline

Spell checking

I did not reinvent the wheel. I use external spell checking engine. I checked around and found few spell check engines available from Python. I decided to use PyEnchant. It is cross platform, has clean interface and responsive author.

Usage example

Basic usage is really simple, but sometimes there is a need to:

• skip\exclude some words from checking
• redefine error messages destination, for example to print to some file
• exclude(include) files from(to) spell checking process by file location ( very useful option in multi-project environment )

"More complex" example:

import pydsc
#check for spell errors only in files under "/home/roman/pygccxml" directory
pydsc.include( "/home/roman/pygccxml" )
pydsc.ignore( [ 'normcase', 'normpath' ] )
import readline

Download

http://sourceforge.net/project/showfiles.php?group_id=118209