ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Павлухин Иван <vololo...@gmail.com>
Subject Re: Abbreviation code-style requirement.
Date Thu, 01 Nov 2018 14:45:58 GMT
Hi Yakov and all,

Recently I went through abbreviations list [1] to find items which are not
clear
for me. After the list was shortened by Yakov and others most of them have
gone.
But pay attention to "lic -> license". I cannot find usages of it in Ignite
codebase?
Could it be removed as well?

And a little follow up. I worry how comfortable is contribution for an
external
contributor with presence of abbreviation rules. I always thought that long
names are common practice in Java world. And our abbreviations might
distract
a typical Java engineer. Does it make any sense?

[1]
https://cwiki.apache.org/confluence/display/IGNITE/Abbreviation+Rules#AbbreviationRules-VariableAbbreviation

чт, 1 нояб. 2018 г. в 17:33, Dmitriy Pavlov <dpavlov.spb@gmail.com>:

> Hi Yakov, thank you for your efforts.
>
> I think no one is suggesting de-abbreviate, it would be no-sense work to
> do. I think the initial reason to start this discussion was the case when
> abbreviation seemed as hiding meaning, and multi-word. I'm glad we agree
> multiword complex variables may be non-abbreviated if it is meaningful.
>
> Vyacheslav D.,
>
> could you please take a look and would you like to change abbrev plugin
> rules?
>
> Sincerely,
> Dmitriy Pavlov
>
> чт, 1 нояб. 2018 г. в 17:27, Yakov Zhdanov <yzhdanov@apache.org>:
>
> > Igniters,
> >
> > I have shortened the list of abbreviation rules and edited our wiki page
> -
> > https://cwiki.apache.org/confluence/display/IGNITE/Abbreviation+Rules.
> > Thanks to Vladimir Ozerov and Alexey Goncharuk for their useful feedback.
> > My idea was to leave only "common sense" abbreviations and those that are
> > Ignite domain specific.
> >
> > I would also suggest that we treat names mentioned in the table on the
> page
> > as names that are required to be abbreviated. Please take this into
> account
> > when conducting code reviews.
> >
> > Thanks!
> >
> > --Yakov
> >
>


-- 
Best regards,
Ivan Pavlukhin

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message