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

[DOCS] salt.modules.saltcheck has duplicate examples and a confusing definition #63364

Open
M3GH4NN opened this issue Dec 22, 2022 · 1 comment
Labels
docstring-update string edits Documentation Relates to Salt documentation module doc standards severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-quick-fix

Comments

@M3GH4NN
Copy link
Contributor

M3GH4NN commented Dec 22, 2022

Description

  1. Duplicate examples. "EXAMPLE WITH JINJA" and "EXAMPLE WITH SETUP STATE INCLUDING PILLAR".
  2. Clarification needed for assertion definition:

assertion:
(str) One of the supported assertions and required except for saltcheck.state_apply Tests which fail the assertion and expected_return, cause saltcheck to exit which a non-zero exit code.

This sentence is confusing and I have a hard time understanding what it means.

Suggested Fix
Duplicate examples are confusing and the definition for assertion is extremely confusing

Type of documentation
salt.modules.saltcheck

Location or format of documentation
saltcheck examples
assertion definition

Additional context
Add any other context or screenshots about the feature request here.

@M3GH4NN M3GH4NN added Documentation Relates to Salt documentation needs-triage labels Dec 22, 2022
@welcome
Copy link

welcome bot commented Dec 22, 2022

Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here’s some information that may help as you continue your Salt journey.
Please be sure to review our Code of Conduct. Also, check out some of our community resources including:

There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar.
If you have additional questions, email us at saltproject@vmware.com. We’re glad you’ve joined our community and look forward to doing awesome things with you!

@barbaricyawps barbaricyawps added severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around module doc standards docstring-update string edits time-estimate-quick-fix and removed needs-triage labels Jan 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docstring-update string edits Documentation Relates to Salt documentation module doc standards severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-quick-fix
Projects
None yet
Development

No branches or pull requests

2 participants