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

Add description requirement to meta requirement #116

Open
adthrasher opened this issue Jul 9, 2024 · 2 comments
Open

Add description requirement to meta requirement #116

adthrasher opened this issue Jul 9, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@adthrasher
Copy link
Member

fn missing_section(name: &str, section: Section, context: Context, span: Span) -> Diagnostic {

This rule should notify users that the newly added meta section must include a description key or the user will immediately receive a new lint warning from DescriptionMissing.

@a-frantz
Copy link
Member

a-frantz commented Jul 9, 2024

This problem sparked an idea for "linking" rules. I imagine the output of sprocket explain MissingMetas saying You should also look at 'DescriptionMissing' (or something to that effect). This linkage would go in one direction. Presumably a user invoking sprocket explain DescriptionMissing has already written meta sections and shouldn't be linked back to MissingMetas.

The Rule trait could have a new method fn linked_rules() -> Vec<&'static str> where the Vec contains other Rule IDs.

The above text is a tangent and has been migrated to its own issue (#173). This issue should remain focused on clarifying explanation() text

@a-frantz a-frantz added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 12, 2024
@a-frantz
Copy link
Member

We probably have other explanation() text that could use wordsmithing. Whoever gets around to rewording the MissingMetas rule, I'd encourage them to take a pass at our other lint rules too!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants