Skip to content

Conversation

@courtneypacheco
Copy link

Updating the docstring for the audio plugin to include more info and sample usage

Courtney Pacheco added 8 commits December 15, 2020 09:21
Adding a docstring to the sysctl plugin that describes what the
plugin does, what its parameters are, and how it should be used.
Fixing inconsistent spacing in the docstring and modifying the term
`name=value` to be consistent with the `sysctl` documentation by
using `variable=value`.
… examples.

Originally, the documentation for Tuned mentioned to use the form of
`name=variable` when specifying sysctl options in a Tuned profile, but when
looking at `man sysctl`, the terminology used is actually `variable=value`.
… examples.

Originally, the documentation for Tuned mentioned to use the form of
`name=variable` when specifying sysctl options in a Tuned profile, but when
looking at `man sysctl`, the terminology used is actually `variable=value`.
The docstring is now updated with more descriptions and now
includes example usage.
@jmencak
Copy link
Contributor

jmencak commented Jan 4, 2021

Thank you for the PR. Why is this PR exactly the same as #315 ? I.e., both include docstrings for sysctl and audio plugins. Also, I'd suggest squashing the commits to a bare minimum prior to merge. Finally, I remember having been asked to --signoff by tuned mainainers in the past (see the git log).

@courtneypacheco
Copy link
Author

Thank you for the PR. Why is this PR exactly the same as #315 ? I.e., both include docstrings for sysctl and audio plugins. Also, I'd suggest squashing the commits to a bare minimum prior to merge. Finally, I remember having been asked to --signoff by tuned mainainers in the past (see the git log).

Yeah, I made a mistake when pushing the commit. I'll squash the commits next time and check to see why I have the sysctl and audio plugins in the same commit. I apologize for that. Not sure why I'm getting both plugin docstrings in this PR.

@yarda
Copy link
Contributor

yarda commented Jan 21, 2021

@courtneypacheco please squash the commits to one. Use e.g. git rebase -i for it, then force push from the branch git push -f.

@jmencak
Copy link
Contributor

jmencak commented Apr 8, 2021

Obsoleted by: #337

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants