Skip to content

Commit 07c0a2b

Browse files
committed
docs: adding commentaries for modules (printed informations in imports)
1 parent f961f96 commit 07c0a2b

File tree

7 files changed

+14
-0
lines changed

7 files changed

+14
-0
lines changed

β€Žlanguage_tool_python/__init__.pyβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""LanguageTool API for Python."""
2+
13
from .language_tag import LanguageTag
24
from .match import Match
35
from .server import LanguageTool, LanguageToolPublicAPI

β€Žlanguage_tool_python/config_file.pyβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Module for configuring LanguageTool's local server."""
2+
13
from typing import Any, Dict
24

35
import atexit

β€Žlanguage_tool_python/download_lt.pyβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""LanguageTool download module."""
2+
13
import logging
24
import os
35
import re

β€Žlanguage_tool_python/language_tag.pyβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""LanguageTool language tag normalization module."""
2+
13
import re
24
from typing import Iterable, Any
35
from functools import total_ordering

β€Žlanguage_tool_python/match.pyβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""LanguageTool API Match object representation and utility module."""
2+
13
import unicodedata
24
from collections import OrderedDict
35
from typing import Any, Dict, Tuple, Iterator, OrderedDict as OrderedDictType, List, Optional

β€Žlanguage_tool_python/server.pyβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""LanguageTool server management module."""
2+
13
from typing import Dict, List, Optional, Any, Set
24

35
import atexit

β€Žlanguage_tool_python/utils.pyβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Utility functions for the LanguageTool library."""
2+
13
from typing import List, Tuple, Optional
24
from shutil import which
35

0 commit comments

Comments
Β (0)