Re: [PATCH v2] docs: Document camelCase preference for XML elements and attributes

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxx>
> Signed-off-by: Michal Privoznik <mprivozn@xxxxxxxxxx>
> ---
> 
> 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 @@
>          src/libvirt_public.syms
>      </code></p>
>  
> +    <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@xxxxxxxxxx>




[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux