Skip to content

Commit b3ddf9c

Browse files
authored
Merge pull request #31 from jcfr/improve-docstrings
DOC: Additional python docstring fixes
2 parents d96a871 + 53fac9d commit b3ddf9c

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

codespell.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,16 @@ def splitCamelCase(word):
5858

5959

6060
def getMimeType(filepath):
61-
"""Map `filepath`` extension to file type."""
61+
"""Map ``filepath`` extension to file type."""
6262
name, ext = os.path.splitext(filepath)
6363
return SUFFIX2MIME.get(ext, "text/plain")
6464

6565

6666
def load_text_file(filename):
67-
"""
67+
"""Parse plain text file as list of ``comment_parser.common.Comment``.
68+
6869
For a regular text file, we don't need to parse it for comments. We
69-
just pass every line to the spell checked.
70+
just pass every line to the spellchecker.
7071
"""
7172

7273
output = []

0 commit comments

Comments
 (0)