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

Issue warning for duplicate descriptions or titles #679

Open
ElliotSilver opened this issue Apr 27, 2023 · 4 comments
Open

Issue warning for duplicate descriptions or titles #679

ElliotSilver opened this issue Apr 27, 2023 · 4 comments
Assignees
Labels
Approved Change has been reviewed and accepted and can now be applied to the templates enhancement New feature or request

Comments

@ElliotSilver
Copy link

I just became aware that, likely due to a cut and paste error, an IG I'm working on has two resources with the same title on the artifacts page, and several more with the same couple of descriptions.

There may be limited reasons to have duplicate titles or descriptions (multiple versions of the same ValueSet--or an expansion of an intensional ValueSet--within one IG are an unlikely, but potentially reasonable instance).

Since duplicate titles and descriptions are not usually (but are occasionally) desired it makes sense to flag this situation as a warning.

I can't think of other elements that should also be flagged as usually be unique within an IG.

@lmckenzi
Copy link
Contributor

Are you using the HL7 template? It will belly-ache because duplicate names cause Jira issues. The base template won't.

@ElliotSilver
Copy link
Author

No, this isn't an HL7 template, but it's also not names that I ran into trouble with--it's titles and descriptions.

@ElliotSilver
Copy link
Author

Consider issuing warning for descriptions, titles or names which are just copied from one of the other elements.

@lmckenzi
Copy link
Contributor

lmckenzi commented May 2, 2023

We think it should be an error if there are multiple non-example resources of the same resource type with the same "name" - but need confirmation from @grahamegrieve that it's not possible to have multiple versions of the same resource (different ids, same canonical) in a single package..

For examples, treat it as a warning if multiple resources of the same type have the same "name"

Also raise a warning if title or description are not distinct across all resources in an IG (regardless of type or whether they are examples)

The title and description warnings should hold both for the metadata on the resources as well as the entries in ImplementationGuide.definition.resource.

@lmckenzi lmckenzi added enhancement New feature or request Approved Change has been reviewed and accepted and can now be applied to the templates labels May 2, 2023
@lmckenzi lmckenzi self-assigned this Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved Change has been reviewed and accepted and can now be applied to the templates enhancement New feature or request
Projects
Development

No branches or pull requests

2 participants