diff options
| author | Philip Kaludercic <philipk@posteo.net> | 2022-02-05 17:13:35 +0100 |
|---|---|---|
| committer | Philip Kaludercic <philipk@posteo.net> | 2022-02-05 17:13:35 +0100 |
| commit | 503b13f1b18fb1e4f3bdb66b6363dc44fd0a2ee2 (patch) | |
| tree | bb01ca867e44cc9de98638f26cbdb2b671da69bc /compat-macs.el | |
| parent | 0125f90e64acdde9d3d4508a779e7b7d5f83be62 (diff) | |
Add compat-help as an infrastructure to manage relevant notes
This is a voluntary library a developer might load to have notes
inserted into help buffers of functions that might differ from their
intuitive or expected behaviour.
Diffstat (limited to 'compat-macs.el')
| -rw-r--r-- | compat-macs.el | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/compat-macs.el b/compat-macs.el index c7878d0..43e2ab9 100644 --- a/compat-macs.el +++ b/compat-macs.el @@ -61,6 +61,9 @@ attributes are handled, all others are ignored: - :realname :: Manual specification of a \"realname\" to use for the compatibility definition (symbol). +- :notes :: Additional notes that a developer using this + compatibility function should keep in mind. + TYPE is used to set the symbol property `compat-type' for NAME." (let* ((min-version (plist-get attr :min-version)) (max-version (plist-get attr :max-version)) @@ -100,6 +103,8 @@ TYPE is used to set the symbol property `compat-type' for NAME." `(progn (put ',realname 'compat-type ',type) (put ',realname 'compat-version ,version) + (put ',realname 'compat-doc ,(plist-get attr :note)) + (put ',name 'compat-def ',realname) ,(funcall def-fn realname version) ,(if feature ;; See https://nullprogram.com/blog/2018/02/22/: |