| 1 | # speling.py |
| 2 | # a happy little python module that provides spellchecking |
| 3 | |
| 4 | # all these fuctions are methods of the dictionary object |
| 5 | def load_dictionary() |
| 6 | """Takes a file path and loads a dictionary file into memory, |
| 7 | returning the dictionary object. This function is called whenever a |
| 8 | dictionary object is created.""" |
| 9 | pass |
| 10 | |
| 11 | def save_dictionary() |
| 12 | """Saves a dictionary object to disk, takes an optional file path to save |
| 13 | it in a place different than its original location.""" |
| 14 | pass |
| 15 | |
| 16 | def add_entry() |
| 17 | """Takes a word (string) and adds it to the dictionary object.""" |
| 18 | pass |
| 19 | |
| 20 | def remove_entry() |
| 21 | """Takes a word (string) and removes it from the dictionary object. |
| 22 | Returns true if it was successful.""" |
| 23 | pass |
| 24 | |
| 25 | def check_word() |
| 26 | """Takes a word (string) and looks it up in the dictionary object. Returns |
| 27 | a list, containing the same word if the word is spelled correctly, or |
| 28 | else a list of any possible corrections out of the dictionary object.""" |
| 29 | pass |
| 30 | |
| 31 | def import_entries() |
| 32 | """Takes a file name and imports dictionary entries from the text file. |
| 33 | Returns 0 if successful.""" |
| 34 | pass |
| 35 | |
| 36 | def export_entries() |
| 37 | """Takes a file name and exports dictionary entries into a text file. |
| 38 | Returns 0 if successful.""" |
| 39 | pass |