Skip to content

Commit 5f573df

Browse files
committed
More info about history messaging
Closes jupyter/notebook#1586
1 parent 40ed846 commit 5f573df

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

docs/messaging.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -623,11 +623,12 @@ Message type: ``history_request``::
623623
# So far, this can be 'range', 'tail' or 'search'.
624624
'hist_access_type' : str,
625625

626-
# If hist_access_type is 'range', get a range of input cells. session can
627-
# be a positive session number, or a negative number to count back from
626+
# If hist_access_type is 'range', get a range of input cells. session
627+
# is a number counting up each time the kernel starts; you can give
628+
# a positive session number, or a negative number to count back from
628629
# the current session.
629630
'session' : int,
630-
# start and stop are line numbers within that session.
631+
# start and stop are line (cell) numbers within that session.
631632
'start' : int,
632633
'stop' : int,
633634

@@ -657,6 +658,18 @@ Message type: ``history_reply``::
657658
'history' : list,
658659
}
659660

661+
.. note::
662+
663+
Most of the history messaging options are not used by Jupyter frontends, and
664+
many kernels do not implement them. If you're implementing these messages in
665+
a kernel, the 'tail' request is the most useful; this is used by the Qt
666+
console, for example. The notebook interface does not use history messages
667+
at all.
668+
669+
This interface was designed by exposing all the main options of IPython's
670+
history interface. We may remove some options in a future version of the
671+
message spec.
672+
660673
.. _msging_is_complete:
661674

662675
Code completeness

0 commit comments

Comments
 (0)