Function: forge-read-topic

forge-read-topic is a natively compiled function defined in forge-topic.el.

Signature

(forge-read-topic PROMPT &optional NO-REQUIRE-MATCH)

Documentation

Read an active topic with completion using PROMPT.

Open, unread and pending topics are considered active. Default to the current topic, even if it isn't active. Return the ID of the selected topic.

While completion is in progress, + (forge-read-topic-lift-limit) lifts the limit, extending the completion candidates to include all topics.

If forge-limit-topic-choices is nil, then all candidates can be selected from the start.

If optional NO-REQUIRE-MATCH is non-nil, then a topic that isn't among the completion candidates can be selected. If such a topic is selected, no topic ID can be returned. Instead return an integer or the input. For a Github repository the input must be an integer, which is returned. For a Gitlab repository the input must have the form "#N" or "!N",
(because here just an integer N would be ambiguous), which is returned
as a string.

Source Code

;; Defined in /nix/store/923zwib42c4qw6x4xps0cv1wi8qcd6lp-emacs-packages-deps/share/emacs/site-lisp/elpa/forge-20261005.753/forge-topic.el
;;; Read

(defun forge-read-topic (prompt &optional no-require-match)
  "Read an active topic with completion using PROMPT.

Open, unread and pending topics are considered active.  Default to the
current topic, even if it isn't active.  Return the ID of the selected
topic.

\\<forge-read-topic-minibuffer-map>While completion is in progress, \
\\[forge-read-topic-lift-limit] lifts the limit, extending the
completion candidates to include all topics.

If `forge-limit-topic-choices' is nil, then all candidates can be
selected from the start.

If optional NO-REQUIRE-MATCH is non-nil, then a topic that isn't among
the completion candidates can be selected.  If such a topic is selected,
no topic ID can be returned.  Instead return an integer or the input.
For a Github repository the input must be an integer, which is returned.
For a Gitlab repository the input must have the form \"#N\" or \"!N\",
\(because here just an integer N would be ambiguous), which is returned
as a string."
  (forge--read-topic prompt
                     #'forge-current-topic
                     (forge--topics-spec :type 'topic :active t)
                     (forge--topics-spec :type 'topic :active nil
                                         :state nil :limit nil)
                     (and no-require-match 'any)))