diff options
| author | Louis Maddox <lmmx@users.noreply.github.com> | 2021-07-18 21:44:45 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-18 21:44:45 +0300 |
| commit | 6d0993825a89b1a8af8496e76b6dcdafa878e95f (patch) | |
| tree | 1853139b3cf4a0d08555d1cc0d07c42a67e75d3d /sphinx/writers | |
| parent | 515f46ce40f177eb66abb0db8055dc870d8af766 (diff) | |
Improve docstrings in sphinx.writers.latex
Diffstat (limited to 'sphinx/writers')
| -rw-r--r-- | sphinx/writers/latex.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 18d059584..855052c5a 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -35,7 +35,7 @@ from sphinx.util.texescape import tex_replace_map try: from docutils.utils.roman import toRoman except ImportError: - # In Debain/Ubuntu, roman package is provided as roman, not as docutils.utils.roman + # In Debian/Ubuntu, roman package is provided as roman, not as docutils.utils.roman from roman import toRoman # type: ignore if TYPE_CHECKING: @@ -123,7 +123,7 @@ class Table: self.col = 0 self.row = 0 - # A mapping a table location to the cell_id (cell = rectangular area) + # A dict mapping a table location to a cell_id (cell = rectangular area) self.cells: Dict[Tuple[int, int], int] = defaultdict(int) self.cell_id = 0 # last assigned cell_id @@ -202,7 +202,7 @@ class Table: class TableCell: - """A cell data of tables.""" + """Data of a cell in a table.""" def __init__(self, table: Table, row: int, col: int) -> None: if table.cells[(row, col)] == 0: @@ -445,8 +445,7 @@ class LaTeXTranslator(SphinxTranslator): return body def format_docclass(self, docclass: str) -> str: - """ prepends prefix to sphinx document classes - """ + """Prepends prefix to sphinx document classes""" warnings.warn('LaTeXWriter.format_docclass() is deprecated.', RemovedInSphinx50Warning, stacklevel=2) if docclass in self.docclasses: |