Skip to content

Fix argument description in "artifactfile" #255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 18, 2025
Merged

Fix argument description in "artifactfile" #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/api/scripts/target-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,13 +267,15 @@ os.cp(target:targetfile(), "/tmp/")

::: tip API
```lua
target:artifactfile()
target:artifactfile(kind: <string>)
```
:::

#### Parameter Description

No parameters required for this function.
| Parameter | Description |
|-----------|-------------|
| kind | Target kind |
Copy link

@gemini-code-assist gemini-code-assist bot Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The description for the kind parameter is a bit generic. To improve clarity for users, it would be helpful to be more specific about the expected values, especially since there seems to be only one supported value at the moment based on the usage example.

Suggested change
| kind | Target kind |
| kind | The kind of artifact file. Currently, only `implib` is supported to get the import library for a Windows DLL. |


#### Usage

Expand Down
6 changes: 4 additions & 2 deletions docs/zh/api/scripts/target-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,13 +269,15 @@ os.cp(target:targetfile(), "/tmp/")

::: tip API
```lua
target:artifactfile()
target:artifactfile(kind: <string>)
```
:::

#### 参数说明

此函数不需要参数。
| 参数 | 描述 |
|------|---------|
| kind | 目标类型 |
Copy link

@gemini-code-assist gemini-code-assist bot Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The description for the kind parameter, "目标类型", is a bit generic. To improve clarity for users, it would be helpful to be more specific about the expected values, especially since there seems to be only one supported value at the moment based on the usage example.

Suggested change
| kind | 目标类型 |
| kind | 产物文件类型。目前仅支持 `implib`，用于获取 Windows DLL 的导入库文件。 |


#### 用法说明

Expand Down