AstralTransRocketries/mcedit2
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rewrite a docstring in RevisionHistory

Browse Source
This commit is contained in:
David Vierra 2016-09-16 04:19:38 -10:00
parent dd4e271a6b
commit 8a65da661c
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/mceditlib/revisionhistory.py
View File

@ -337,13 +337,28 @@ class RevisionHistory(object):
def writeAllChangesIter(self, requestedRevision=None): def writeAllChangesIter(self, requestedRevision=None):
""" """
Write all changes to the root world folder, preserving undo history. The world folder Write all changes to the root world folder, preserving undo history.
becomes the new head node. The previous head node is no longer valid after calling
writeAllChanges. Specify a revision to only save changes up to and including that If a revision is requested, the state of the world at that revision will be
revision. written, otherwise, the last node in the history is used.
All nodes between the root node and the requested node, inclusive, are replaced
with new nodes. The old nodes are no longer valid. The root node will be placed at
the position in the nodes list previously occupied by the requested node.
:return: Parameters
:rtype: ----------
requestedRevision: RevisionHistoryNode | int | None
If given, this specifies the revision to write to the world folder, otherwise
the most recent revision is written.
Returns
-------
progress: Iterator[(current, max, status)]
Progress information for the write-changes task.
""" """
# XXXXX wait for async writes to complete here # XXXXX wait for async writes to complete here
# Progress counts: # Progress counts: