Update README and TODOs

This commit is contained in:
kagami 2024-01-02 11:50:17 +08:00
parent 11420f7808
commit 07a418f239
3 changed files with 10 additions and 8 deletions

View File

@ -5,5 +5,12 @@ This is an example of how to use the chatmark module.
Usage:
1. Copy the `chatmark_example` folder under `~/.chat/workflow/org`
2. Use the command `/chatmark_example` in devchat vscode plugin.
2. Create `command.yml` under `~/.chat/workflow/org/chatmark_example` with the following content:
```yaml
description: chatmark examples
steps:
- run: $command_python $command_path/main.py
```
3. Use the command `/chatmark_example` in devchat vscode plugin.

View File

@ -1,3 +0,0 @@
description: chatmark examples
steps:
- run: $command_python $command_path/main.py

View File

@ -181,7 +181,6 @@ class TextEditor(Widget):
Reviewed-by: Z
Refs: #123
```
# TODO: 实际返回与文档描述不符是key-value
"""
def __init__(self, text: str, title: Optional[str] = None):
@ -237,7 +236,7 @@ class Radio(Widget):
def __init__(
self,
options: List[str],
# TODO: 设计缺陷 or Feature无法指定默认选项
# TODO: implement default_selected after the design is ready
# default_selected: Optional[int] = None,
title: Optional[str] = None,
) -> None:
@ -246,7 +245,7 @@ class Radio(Widget):
default_selected: index of the option to be selected by default, default to None
title: title of the widget
"""
# TODO: 设计缺陷 or Feature无法指定默认选项
# TODO: implement default_selected after the design is ready
# if default_selected is not None:
# assert 0 <= default_selected < len(options)
@ -317,7 +316,6 @@ class Button(Widget):
```
# NOTE: almost the same as Radio essentially
# TODO: 点完后button显示有个xbug or feature
"""
def __init__(