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

Unfinished sentence in docs/profiles.md #4358

Closed
aj2s opened this issue Oct 4, 2024 · 2 comments · Fixed by #4380
Closed

Unfinished sentence in docs/profiles.md #4358

aj2s opened this issue Oct 4, 2024 · 2 comments · Fixed by #4380
Labels
bug

Comments

@aj2s
Copy link

aj2s commented Oct 4, 2024 •
edited
Loading

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
binojmn pushed a commit to binojmn/ansible-lint that referenced this issue Oct 29, 2024
Fixing the issue "Unfinished sentence in docs/profiles.md ansible#4358"
bf98c6c
@binojmn
Copy link
Contributor

binojmn commented Oct 29, 2024

@cavcrosby , have raised the PR. Please let me know if any other changes needed

@Qalthos Qalthos mentioned this issue Oct 30, 2024
Merged
ssbarnea added a commit that referenced this issue Nov 2, 2024
@binojmn @ssbarnea
Fixing the issue "Unfinished sentence in docs/profiles.md #4358" (#4380)
79c3707 
Co-authored-by: bmelathn <binoj.melath.nalinakshan.nair@oracle.com>
Co-authored-by: Sorin Sbarnea <ssbarnea@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
🧰 devtools project board
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixing the issue "Unfinished sentence in docs/profiles.md #4358" binojmn/ansible-lint
4 participants
@Qalthos @binojmn @cavcrosby @aj2s