Address code review feedback: clarify private function comment

Co-authored-by: Kinneyzhang <38454496+Kinneyzhang@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2025-12-15 02:56:24 +00:00
parent 62b5e47548
commit 9ed2aafe23

4
tp.el
View File

@ -673,13 +673,13 @@ OBJECT defaults to current buffer."
(nreverse intervals))))) (nreverse intervals)))))
(t (error "Invalid arguments to tp-get")))) (t (error "Invalid arguments to tp-get"))))
;;; Fine-grained property manipulation for nested properties (internal) ;;; Private functions for fine-grained property manipulation
(defun tp--get-sub (position property sub-property &optional object) (defun tp--get-sub (position property sub-property &optional object)
"Get SUB-PROPERTY from PROPERTY at POSITION in OBJECT. "Get SUB-PROPERTY from PROPERTY at POSITION in OBJECT.
For example, get :foreground from a face property. For example, get :foreground from a face property.
OBJECT defaults to current buffer. OBJECT defaults to current buffer.
Internal function - use `tp-get' with nested path for public API." This is a private function - use `tp-get' with nested path for public API."
(let ((prop-value (get-text-property position property object))) (let ((prop-value (get-text-property position property object)))
(cond (cond
;; Property is a plist (e.g., (:foreground \"red\" :weight bold)) ;; Property is a plist (e.g., (:foreground \"red\" :weight bold))