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

Unfinished sentence in docs/profiles.md #4358

Open
aj2s opened this issue Oct 4, 2024 · 1 comment
Open

Unfinished sentence in docs/profiles.md #4358

aj2s opened this issue Oct 4, 2024 · 1 comment
Labels

Comments

@aj2s
Copy link

aj2s commented Oct 4, 2024

Summary

Ansible-lint profiles gradually increase the strictness of rules as your Ansible content lifecycle.

Is it me, or does it seem like this sentence in docs/profiles.md is unfinished?

Totally guessing how the sentence was meant to end:

  • "Ansible-lint profiles gradually increase the strictness of rules of your Ansible content lifecycle." ? Even then, I don't know what that means.

  • "Ansible-lint profiles gradually increase the strictness of rules as your Ansible content lifecycle matures." ? Still unsure, but that sounds like a finished sentence to me

@aj2s aj2s added bug new Triage required labels Oct 4, 2024
@cavcrosby
Copy link
Contributor

I like the second sentence you suggested, though I would probably modify it slightly to say the following.

Ansible-lint profiles gradually increase the strictness of rules as your Ansible content matures.

I'd recommend submitting a PR for the maintainers to take a look.

@Qalthos Qalthos removed the new Triage required label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

3 participants