fix spelling in module docs

[rndmh3ro]

No description provided.

[codecov]

Codecov Report

Merging #83 (6cffecd) into master (ed6b034) will decrease coverage by 0.43%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
- Coverage   93.71%   93.27%   -0.44%     
==========================================
  Files          17       17              
  Lines         493      684     +191     
  Branches       47       72      +25     
==========================================
+ Hits          462      638     +176     
  Misses          9        9              
- Partials       22       37      +15     

Impacted Files	Coverage Δ
plugins/modules/icinga_command.py	94.11% <ø> (-1.54%)	⬇️
plugins/modules/icinga_command_template.py	93.93% <ø> (-1.52%)	⬇️
plugins/modules/icinga_endpoint.py	94.28% <ø> (-1.37%)	⬇️
plugins/modules/icinga_host.py	93.54% <ø> (-1.69%)	⬇️
plugins/modules/icinga_host_template.py	93.33% <ø> (-1.67%)	⬇️
plugins/modules/icinga_hostgroup.py	93.54% <ø> (-1.46%)	⬇️
plugins/modules/icinga_notification.py	93.93% <ø> (-1.30%)	⬇️
plugins/modules/icinga_notification_template.py	93.75% <ø> (-1.25%)	⬇️
plugins/modules/icinga_service.py	93.75% <ø> (+0.89%)	⬆️
plugins/modules/icinga_service_apply.py	96.22% <ø> (+1.48%)	⬆️
... and 22 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ed6b034...6cffecd. Read the comment docs.

[schurzi]

inconsistent use of - as I understand they should be everywhere, when there are multiple lines/sentences?

[rndmh3ro]

inconsistent use of - as I understand they should be everywhere, when there are multiple lines/sentences?

I fixed hopefully all inconsistences. Can you please re-check?

[felixfontein]

The short description is the only thing that should not end in a period.

[rndmh3ro]

Thanks, I'll fix that.

[dmsimard]

@felixfontein is that something that you have to know or is it picked up by linting/sanity/etc ?

[felixfontein]

@dmsimard that's something you have to know, or use @Andersson007's checking tool for.

[rndmh3ro]

Well, TIL: https://github.com/Andersson007/ansible_reviewer

Is this tool something I can rely on that it finds things that are worth changing?

[dmsimard]

@rndmh3ro to my knowledge the tool is not used in an official capacity right now but we are, generally speaking, looking at opportunities to automate these kind of checks in order to make it easier for collection maintainers to test and monitor for policy and best practices compliance.