Skip to content
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

Unclear and partly wrong (?) description of task dependencies #27684

Closed
jorander opened this issue Jan 14, 2024 · 1 comment · Fixed by #27711
Closed

Unclear and partly wrong (?) description of task dependencies #27684

jorander opened this issue Jan 14, 2024 · 1 comment · Fixed by #27711
Labels
a:documentation Documentation content affects-version:8.4 affects-version:8.5 in:scheduler execution plan, task graph, work lease, project lock
Milestone

Comments

@jorander
Copy link
Contributor

Issue type

Wrong or misleading information

Problem description

The text under Figure 1 in the paragraph linked below says: "You can see that the test task is not executed, even though it depends on the dist task.".
This sentence trips me up and I think it might be wrong. Following the arrows in the picture I would argue that it is the dist task that depends on the test task, not the other way around.

In addition, the last sentence of the paragraph says: "Those dependencies of test that another task requires, such as compile, are still executed."
This sentence uses the word "requires" instead of "depends" event though I think the meaning is the same as when the word "depends" is used in the first sentence. I think it is better to consistently use one word, in this case "depends".

Context (optional)

This paragraph was a bit hard to read and understand due to these two problems pointed out above.

If you agree the paragraph should be changed along the lines I've suggested I'm happy to take on this change as a first contribution to the Gradle repository.

Page with the problem

https://docs.gradle.org/current/userguide/command_line_interface.html#sec:excluding_tasks_from_the_command_line

@jorander jorander added a:documentation Documentation content to-triage labels Jan 14, 2024
@cobexer
Copy link
Member

cobexer commented Jan 16, 2024

Thank you for your interest in Gradle!

This is a valid documentation issue.


@jorander contributions are welcome!
See CONTRIBUTING.md for more information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:documentation Documentation content affects-version:8.4 affects-version:8.5 in:scheduler execution plan, task graph, work lease, project lock
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants