Remove non-existent APIs from documentation: tp-layer-propertize, tp-group-propertize, tp-put alias
Co-authored-by: Kinneyzhang <38454496+Kinneyzhang@users.noreply.github.com>
This commit is contained in:
parent
8bbc2a4437
commit
321e124b74
39
README.md
39
README.md
@ -502,44 +502,6 @@ Add/merge properties on regexp matches with deep merge support.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Propertize Functions
|
|
||||||
|
|
||||||
#### `tp-layer-propertize` - Apply Layer to Object
|
|
||||||
|
|
||||||
```elisp
|
|
||||||
(tp-layer-propertize OBJECT LAYER &optional START END)
|
|
||||||
```
|
|
||||||
|
|
||||||
Apply a predefined layer's properties to an object.
|
|
||||||
|
|
||||||
**Examples:**
|
|
||||||
|
|
||||||
```elisp
|
|
||||||
;; Define a layer first
|
|
||||||
(tp-layer-define highlight '(face (:background "yellow")))
|
|
||||||
|
|
||||||
;; Apply to string
|
|
||||||
(tp-layer-propertize "Important" 'highlight)
|
|
||||||
|
|
||||||
;; Apply to substring
|
|
||||||
(tp-layer-propertize "Hello World" 'highlight 0 5)
|
|
||||||
|
|
||||||
;; Apply to buffer region
|
|
||||||
(tp-layer-propertize (current-buffer) 'highlight 1 10)
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `tp-group-propertize` - Apply Layer Group
|
|
||||||
|
|
||||||
```elisp
|
|
||||||
(tp-group-propertize OBJECT LAYER-GROUP &optional START END)
|
|
||||||
```
|
|
||||||
|
|
||||||
Apply all layers from a layer group to an object.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Search & Navigation Functions
|
### Search & Navigation Functions
|
||||||
|
|
||||||
#### `tp-forward` / `tp-backward`
|
#### `tp-forward` / `tp-backward`
|
||||||
@ -1123,7 +1085,6 @@ For convenience, tp.el provides these aliases:
|
|||||||
|
|
||||||
| Alias | Original Function |
|
| Alias | Original Function |
|
||||||
|-------|-------------------|
|
|-------|-------------------|
|
||||||
| `tp-put` | `tp-set` |
|
|
||||||
| `tp-layer-properties` | `tp-layer-props` |
|
| `tp-layer-properties` | `tp-layer-props` |
|
||||||
| `tp-layer-group-properties` | `tp-group-props` |
|
| `tp-layer-group-properties` | `tp-group-props` |
|
||||||
| `tp-layer-group-undefine` | `tp-group-undefine` |
|
| `tp-layer-group-undefine` | `tp-group-undefine` |
|
||||||
|
|||||||
39
README_CN.md
39
README_CN.md
@ -501,44 +501,6 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### 属性化函数
|
|
||||||
|
|
||||||
#### `tp-layer-propertize` - 将图层应用到对象
|
|
||||||
|
|
||||||
```elisp
|
|
||||||
(tp-layer-propertize OBJECT LAYER &optional START END)
|
|
||||||
```
|
|
||||||
|
|
||||||
将预定义图层的属性应用到对象。
|
|
||||||
|
|
||||||
**示例:**
|
|
||||||
|
|
||||||
```elisp
|
|
||||||
;; 首先定义一个图层
|
|
||||||
(tp-layer-define highlight '(face (:background "yellow")))
|
|
||||||
|
|
||||||
;; 应用到字符串
|
|
||||||
(tp-layer-propertize "Important" 'highlight)
|
|
||||||
|
|
||||||
;; 应用到子字符串
|
|
||||||
(tp-layer-propertize "Hello World" 'highlight 0 5)
|
|
||||||
|
|
||||||
;; 应用到缓冲区区域
|
|
||||||
(tp-layer-propertize (current-buffer) 'highlight 1 10)
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `tp-group-propertize` - 应用图层组
|
|
||||||
|
|
||||||
```elisp
|
|
||||||
(tp-group-propertize OBJECT LAYER-GROUP &optional START END)
|
|
||||||
```
|
|
||||||
|
|
||||||
将图层组中的所有图层应用到对象。
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 搜索和导航函数
|
### 搜索和导航函数
|
||||||
|
|
||||||
#### `tp-forward` / `tp-backward`
|
#### `tp-forward` / `tp-backward`
|
||||||
@ -1122,7 +1084,6 @@
|
|||||||
|
|
||||||
| 别名 | 原函数 |
|
| 别名 | 原函数 |
|
||||||
|------|--------|
|
|------|--------|
|
||||||
| `tp-put` | `tp-set` |
|
|
||||||
| `tp-layer-properties` | `tp-layer-props` |
|
| `tp-layer-properties` | `tp-layer-props` |
|
||||||
| `tp-layer-group-properties` | `tp-group-props` |
|
| `tp-layer-group-properties` | `tp-group-props` |
|
||||||
| `tp-layer-group-undefine` | `tp-group-undefine` |
|
| `tp-layer-group-undefine` | `tp-group-undefine` |
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user