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

documentation inconsistency: "convention" vs "conventions" plugins, package dir vs package in filename #23988

Closed
dsilva opened this issue Feb 21, 2023 · 3 comments · Fixed by #28592
Assignees
Labels
Milestone

Comments

@dsilva
Copy link

dsilva commented Feb 21, 2023

https://docs.gradle.org/current/userguide/custom_plugins.html gives an example filename of my/java-library-convention.gradle.kts (my package directory, singular convention) and https://docs.gradle.org/current/samples/sample_convention_plugins.html uses myproject.java-conventions.gradle.kts (myproject package in the filename, plural conventions). Which one is idiomatic?

Expected Behavior

Consistent examples in gradle docs.

Current Behavior

Examples are inconsistent. This is just a minor issue, but it would be nice to have idiomatic guidance to avoid bike-shedding.

@dsilvasc
Copy link

related: jjohannes/idiomatic-gradle#9

@eskatos
Copy link
Member

eskatos commented Mar 1, 2023

Thank you for your interest in Gradle!

This is a valid documentation issue which we will address.

@lkasso lkasso self-assigned this Apr 24, 2023
@lkasso lkasso linked a pull request Apr 1, 2024 that will close this issue
5 tasks
@lkasso
Copy link
Member

lkasso commented Apr 1, 2024

Closed with #28592, #28167 and #28539

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

Successfully merging a pull request may close this issue.

5 participants