mesonbuild / mesonbuild/meson

doc: description is truncated?

Open
#14,656 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
6.6k
Forks
1.9k
Avg merge
2d 6h
Merged PRs (30d)
33

Description

**Describe the bug**

https://mesonbuild.com/Reference-manual_functions.html#signature14

> depend_files : list[str | file] # files (str,

The comment is truncated? It must come from

https://github.com/mesonbuild/meson/blob/6447eb00d87f439147249dd593635ae14e56d0dd/docs/yaml/functions/custom_target.yaml#L134-L140

IIUC only the first line of the description is shown; then would you adjust the block so that the comment is more explanative?

And, the closing parenthesis is missed, perhaps

```diff
--- a/docs/yaml/functions/custom_target.yaml
+++ b/docs/yaml/functions/custom_target.yaml
@@ -137,3 +137,3 @@ kwargs:
files ([[@str]],
- [[@file]], or the return value of [[configure_file]] that
+ [[@file]]), or the return value of [[configure_file]] that
this target depends on but are not listed in the `command` keyword
```

**To Reproduce**

Open the link.

**Expected behavior**

Something like

> depend_files : list[str | file] # files (str, file), or the return value of configure_file()

Contributor guide

Open the contributing guide

Research direction

Inspect docs/yaml/functions/custom_target.yaml around lines 134-140 and compare its generated output at the linked Reference Manual entry. Confirm whether only the first description line is rendered, then check the proposed closing parenthesis change. Done means the rendered depend_files description is complete and correctly punctuated.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.