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

Avoid using pkg* unified patterns in documentation, as they might introduce ambiguities. #3032

Merged
merged 5 commits into from
Feb 28, 2023

Conversation

oxygene
Copy link

@oxygene oxygene commented Feb 28, 2023

Avoid using pkg* unified patterns in documentation, as they might introduce ambiguities.

There are packages with common prefix out there (or might be introduced in future). Using pkg* e.g. for options could match more than intended by the user, e.g. when a new library pkg-ng is added to the project later.

Prefer using pkg/* instead.

See discussion at conan-io/conan#13233 (comment)

czoido and others added 5 commits February 16, 2023 18:35
There are libraries with a common prefix that might introduce
ambiguities now or later, e.g. zlib and zlib-ng.
Prefer using `pkg/*` over `pkg*` which is more explicit.
@CLAassistant
Copy link

CLAassistant commented Feb 28, 2023

CLA assistant check
All committers have signed the CLA.

@oxygene oxygene changed the title Develop Avoid using pkg* unified patterns in documentation, as they might introduce ambiguities. Feb 28, 2023
@czoido czoido changed the base branch from develop to master February 28, 2023 09:03
Copy link
Member

@memsharded memsharded left a comment

Choose a reason for hiding this comment

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

Thanks for contributing this.

Lets merge it. It might be worth checking the 2.0 docs for possible occurrences of this.

@czoido czoido self-assigned this Feb 28, 2023
@czoido czoido merged commit d61ba28 into conan-io:master Feb 28, 2023
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

Successfully merging this pull request may close these issues.

4 participants