RanchiMall/electrumx
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs for raw headers.

Browse Source
This commit is contained in:
Neil Booth 2018-07-16 19:29:04 +08:00
parent 362499778a
commit e5ea1c10e2
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/protocol-methods.rst
View File

@ -181,16 +181,20 @@ Subscribe to receive block headers when a new block is found.
**Signature**
.. function:: blockchain.headers.subscribe(raw=True)
.. function:: blockchain.headers.subscribe()
.. versionchanged:: 1.2
Optional *raw* parameter added, defaulting to :const:`False`.
.. versionchanged:: 1.3
*raw* parameter deafults to :const:`True`.
.. versionchanged:: 1.4
*raw* parameter removed; responses and notifications pass raw
headers.
* *raw*
:const:`False` or :const:`True`. The value :const:`False` is
deprecated.
This single boolean argument exists in protocol versions 1.2
(defaulting to :const:`False`) and 1.3 (defaulting to
:const:`True`) only.
**Result**