community.mysql
community.mysql copied to clipboard
Improve documentation of the priv parameter.
SUMMARY
The description of the priv parameter contains a short section about column privileges which is not properly rendered and can be improved.
The lines in question are this: https://github.com/ansible-collections/community.mysql/blob/bd86e249d0d3a24ba68951911b12ff008387f9ac/plugins/modules/mysql_user.py#L51-L54
- The
C(…)function seems to not work nice with parenthesis inside is my guess. - Between the privilege keyword and the open parenthesis a space is missing in the examples e.g. Instead of
SELECT(priv1,priv2)it should beSELECT (priv1,priv2). - PR #107 sorts the column names so this can be mentioned as well I guess.
ISSUE TYPE
- Documentation Report
COMPONENT NAME
mysql_user
@JaSafieddine hi, thanks very much for spotting this! Would you like to submit a PR?
If you don't have such experience, I'm writing the quick start guide https://github.com/ansible-collections/community.mysql/pull/112. There are ~20 simple steps how to do it.
You could try and provide feedback. It would be much appreciated because this CONTRIBUTING.md will probably be used in most the collections (in a generalized form). If you don't have time / wish - let me know, I could fix the doc myself, no problem absolutely:) Thank you!
Hi @Andersson007. Sure I can try to create the PR. Thanks for the link to the quick start guide.
@JaSafieddine YW! Cool, if any questions, feel free to ask!
Hi @JaSafieddine any update of the PR ? best
@bmillemathias hi, if you have a wish to update the doc, I'd be happy to review
Any updates on that @bmillemathias @JaSafieddine ?
@rsicart thanks for reminding! It's a great idea to conduct PR/Issue days from time to time.
I've added the help_wanted label, so anyone who wants to contribute can pick it up