comparison mercurial/repository.py @ 40279:4821affc154f

wireproto: fix incorrect function name in docstring The docstring for `iwireprotocolcommandcacher` references an `onoutputfinished` method. The actual name of the function is `onfinished`. Differential Revision: https://phab.mercurial-scm.org/D5090
author Connor Sheehan <sheehan@mozilla.com>
date Sun, 14 Oct 2018 03:42:43 -0400
parents dac438b7346e
children f1a39128da95
comparison
equal deleted inserted replaced
40278:125fc478719f 40279:4821affc154f
1711 of invoking the command function. ``__exit__`` is called and the instance 1711 of invoking the command function. ``__exit__`` is called and the instance
1712 is discarded. 1712 is discarded.
1713 8. The command function is invoked. 1713 8. The command function is invoked.
1714 9. ``onobject()`` is called for each object emitted by the command 1714 9. ``onobject()`` is called for each object emitted by the command
1715 function. 1715 function.
1716 10. After the final object is seen, ``onoutputfinished()`` is called. 1716 10. After the final object is seen, ``onfinished()`` is called.
1717 11. ``__exit__`` is called to signal the end of use of the instance. 1717 11. ``__exit__`` is called to signal the end of use of the instance.
1718 1718
1719 Cache *key* derivation can be influenced by the instance. 1719 Cache *key* derivation can be influenced by the instance.
1720 1720
1721 Cache keys are initially derived by a deterministic representation of 1721 Cache keys are initially derived by a deterministic representation of
1746 re-emit the original objects. They will be forwarded to the output 1746 re-emit the original objects. They will be forwarded to the output
1747 layer and will be processed as if the cacher did not exist. 1747 layer and will be processed as if the cacher did not exist.
1748 1748
1749 Implementations could also choose to not emit objects - instead locally 1749 Implementations could also choose to not emit objects - instead locally
1750 buffering objects or their encoded representation. They could then emit 1750 buffering objects or their encoded representation. They could then emit
1751 a single "coalesced" object when ``onoutputfinished()`` is called. In 1751 a single "coalesced" object when ``onfinished()`` is called. In
1752 this way, the implementation would function as a filtering layer of 1752 this way, the implementation would function as a filtering layer of
1753 sorts. 1753 sorts.
1754 1754
1755 When caching objects, typically the encoded form of the object will 1755 When caching objects, typically the encoded form of the object will
1756 be stored. Keep in mind that if the original object is forwarded to 1756 be stored. Keep in mind that if the original object is forwarded to