Skip to content

doc: description is truncated? #14656

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.

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

Open
e-kwsm opened this issue May 28, 2025 · 1 comment
Open

doc: description is truncated? #14656

e-kwsm opened this issue May 28, 2025 · 1 comment

Comments

@e-kwsm
Copy link
Contributor

e-kwsm commented May 28, 2025

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

depend_files:
type: list[str | file]
description: |
files ([[@str]],
[[@file]], or the return value of [[configure_file]] that
this target depends on but are not listed in the `command` keyword
argument. Useful for adding regen dependencies.

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

--- 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()

@eli-schwartz
Copy link
Member

I suspect the closing parenthesis is supposed to be after "or the return value of configure_file()", actually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants