wireprototypes: clarify documentation of getbundle argument types
authorMartin von Zweigbergk <martinvonz@google.com>
Wed, 18 Sep 2019 13:50:33 -0700
changeset 42955 9668744c9122
parent 42954 2c14bf83b58b
child 42956 3fe40dd6355d
wireprototypes: clarify documentation of getbundle argument types It seems like it was a mix of what the Python code would see and what was sent over the wire. I've tried to clarify both the type seen in Python and how it's transmitted. Differential Revision: https://phab.mercurial-scm.org/D6871
mercurial/wireprototypes.py
--- a/mercurial/wireprototypes.py	Thu Sep 19 07:50:24 2019 +0900
+++ b/mercurial/wireprototypes.py	Wed Sep 18 13:50:33 2019 -0700
@@ -147,14 +147,14 @@
 
 # mapping of options accepted by getbundle and their types
 #
-# Meant to be extended by extensions. It is extensions responsibility to ensure
-# such options are properly processed in exchange.getbundle.
+# Meant to be extended by extensions. It is the extension's responsibility to
+# ensure such options are properly processed in exchange.getbundle.
 #
 # supported types are:
 #
-# :nodes: list of binary nodes
-# :csv:   list of comma-separated values
-# :scsv:  list of comma-separated values return as set
+# :nodes: list of binary nodes, transmitted as space-separated hex nodes
+# :csv:   list of values, transmitted as comma-separated values
+# :scsv:  set of values, transmitted as comma-separated values
 # :plain: string with no transformation needed.
 GETBUNDLE_ARGUMENTS = {
     'heads':  'nodes',