Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ubmarco committed Oct 23, 2023
1 parent 148f5a0 commit 55f8a99
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions sphinx/environment/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@ def master_doctree(self) -> nodes.document:
return self.get_doctree(self.config.root_doc)

def get_doctree_write(self, docname: str) -> nodes.document:
"""Split from the function get_and_resolve_doctree for write phase."""
"""Read the doctree from pickle for the write phase."""
try:
doctree = self._write_doc_doctree_cache.pop(docname)
doctree.settings.env = self
Expand All @@ -630,9 +630,7 @@ def get_and_resolve_doctree(
prune_toctrees: bool = True,
includehidden: bool = False,
) -> nodes.document:
"""Read the doctree from the pickle, resolve cross-references and
toctrees and return it.
"""
"""Get the doctree, resolve cross-references and toctrees and return it."""
if doctree is None:
doctree = self.get_doctree_write(docname)

Expand Down

0 comments on commit 55f8a99

Please sign in to comment.