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.file.seek_read contains incorrect arg name in the description #67074

Open
JayTruscott-dev opened this issue Nov 27, 2024 · 1 comment
Labels
Documentation Relates to Salt documentation needs-triage

Comments

@JayTruscott-dev
Copy link

Description
The args listed for salt.modules.file.seek_read are path, size, offset. But the description of the args lists them as path, seek, offset.

Suggested Fix
Please replace the usage of "seek" as an arg here with the correct name "size" to avoid possible reader confusion.

Type of documentation
Salt Execution Module documentation

Location or format of documentation
https://docs.saltproject.io/en/master/ref/modules/all/[salt.modules.file](https://docs.saltproject.io/en/master/ref/modules/all/salt.modules.file.html#salt.modules.file.seek_read).html#salt.modules.file.seek_read

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

@JayTruscott-dev JayTruscott-dev added Documentation Relates to Salt documentation needs-triage labels Nov 27, 2024
Copy link

welcome bot commented Nov 27, 2024

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 [email protected]. We’re glad you’ve joined our community and look forward to doing awesome things with you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation needs-triage
Projects
None yet
Development

No branches or pull requests

1 participant