Function: help--describe-vector

help--describe-vector is a function defined in keymap.c.

Signature

(help--describe-vector VECTOR PREFIX DESCRIBER PARTIAL SHADOW ENTIRE-MAP MENTION-SHADOW)

Documentation

Insert in the current buffer a description of the contents of VECTOR.

Call DESCRIBER to insert the description of one value found in VECTOR.

PREFIX is a string describing the key which leads to the keymap that this vector is in.

If PARTIAL, it means do not mention suppressed commands.

SHADOW is a list of keymaps that shadow this map. If it is non-nil, look up the key in those maps and don't mention it if it is defined by any of them.

ENTIRE-MAP is the keymap in which this vector appears. If the definition in effect in the whole map does not match the one in this keymap, we ignore this one.

Source Code

// Defined in /usr/src/emacs/src/keymap.c
{
  specpdl_ref count = SPECPDL_INDEX ();
  specbind (Qstandard_output, Fcurrent_buffer ());
  CHECK_VECTOR_OR_CHAR_TABLE (vector);

  bool b_partial = NILP (partial) ? false : true;
  bool b_mention_shadow = NILP (mention_shadow) ? false : true;

  describe_vector (vector, prefix, describer, describe_vector_basic, b_partial,
		   shadow, entire_map, true, b_mention_shadow);
  return unbind_to (count, Qnil);
}