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.

Sign up for GitHub

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

Jump to bottom

Provide diagnostic solution for invalid metadata directives in documentation comments #1111

Open
franklinsch opened this issue Dec 3, 2024 · 0 comments
Open

Provide diagnostic solution for invalid metadata directives in documentation comments #1111

franklinsch opened this issue Dec 3, 2024 · 0 comments
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@franklinsch
Copy link
Contributor

Feature Name

Provide diagnostic solution for invalid metadata directives in documentation comments

Description

With #1107, we introduced the org.swift.docc.Metadata.Invalid<directive name>InDocumentationComment warning which DocC produces when the Metadata directive has a child directive that isn't supported in documentation comments. It would be nice if DocC would offer a solution to remove that child directive for you.

Motivation

No response

Importance

Not very important, it is easy to remove the problematic directive manually.

Alternatives Considered

No response
@franklinsch franklinsch added the enhancement Improvements or enhancements to existing functionality label Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improvements or enhancements to existing functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@franklinsch