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

Consider using true/false for all booleans in docs #397

Closed
samccann opened this issue Nov 28, 2022 · 1 comment · Fixed by #400
Closed

Consider using true/false for all booleans in docs #397

samccann opened this issue Nov 28, 2022 · 1 comment · Fixed by #400
Labels
easyfix Good for the new contributors waiting_on_contributor Needs help. Feel free to engage to get things unblocked

Comments

@samccann
Copy link
Contributor

SUMMARY

Based on the community decision to use true/false for boolean values in documentation and examples, we ask that you evaluate booleans in this collection and consider changing any that do not use true/false (lowercase).

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

docs

ANSIBLE VERSION
2.14
@Akasurde Akasurde added waiting_on_contributor Needs help. Feel free to engage to get things unblocked easyfix Good for the new contributors labels Nov 29, 2022
@vladislav-sharapov
Copy link
Contributor

I can fix this. Can you help me with testing part? How should I test this collection?

@vladislav-sharapov vladislav-sharapov mentioned this issue Dec 8, 2022
Merged
softwarefactory-project-zuul bot added a commit that referenced this issue Dec 22, 2022
@softwarefactory-project-zuul
Merge pull request #400 from vladislav-sharapov/fix-doc-boolean-values
a2ab688 
Fix boolean values in docs

SUMMARY
Fixes #397
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
Docs of several modules
ADDITIONAL INFORMATION
Notes about testing. I'm not sure how to test collections properly. I have ran ansible-test sanity --python 3.10 and ansible-test units --python 3.10 in venv with ansible-core 2.14 (with 0 return code in both cases). To run units test successfully I had to install pytest-forked pip package in addition to this one pytest-xdist from test-requirements.txt.
Note about issue #397. I haven't changed yes here because in this case it is value from /etc/vfstab. Also I've changed yes for parameters masquerade and icmp_block_inversion because they both are converted to bool by boolean function and will be changed to boolean in a future release (1, 2), for required too.

Reviewed-by: Felix Fontein <felix@fontein.de>
Reviewed-by: Hideki Saito <saito@fgrep.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
easyfix Good for the new contributors waiting_on_contributor Needs help. Feel free to engage to get things unblocked
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix boolean values in docs
3 participants
@Akasurde @samccann @vladislav-sharapov