[PATCH v2] docs: Document camelCase preference for XML elements and attributes
eskultet at redhat.com
Thu Oct 15 14:34:54 UTC 2020
On Thu, Oct 15, 2020 at 04:19:48PM +0200, Michal Privoznik wrote:
> Recently I've merged a patch that used hyphens in an attribute
> name. I fixed it later, but turned out we don't document our
> preference which is camelCase.
> Suggested-by: Erik Skultety <eskultet at redhat.com>
> Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
> diff to v1:
> - Extended coding style too.
> docs/api_extension.html.in | 6 ++++++
> docs/coding-style.rst | 15 +++++++++++++++
> 2 files changed, 21 insertions(+)
> diff --git a/docs/api_extension.html.in b/docs/api_extension.html.in
> index 6c64e83314..d7696056ac 100644
> --- a/docs/api_extension.html.in
> +++ b/docs/api_extension.html.in
> @@ -110,6 +110,12 @@
> + <p>
> + Please note that single word names for attributes and elements is
> + preferred. But if you have to use two ore more words please join them in
> + camelCase style.
> + </p>
Hmm, I think it would be worth more if you just linked the coding style page
^here so that we cover all the conventions rather than a single one.
With that addressed, there's no need for v3:
Reviewed-by: Erik Skultety <eskultet at redhat.com>
More information about the libvir-list