Silme:Naming convention: Difference between revisions

Jump to navigation Jump to search

Silme:Naming convention (view source)

Revision as of 11:09, 6 July 2009

736 bytes added ,  6 July 2009
no edit summary
No edit summary
No edit summary
Line 1: Line 1:
Some proposals:


1. Shorten words in names to max. 3-4 characters, like:
== For 0.8 ==
*L10nObject -> L10nObj
*Entity -> Ent
*EntityList -> EntList
*L10nPackage -> L10nPack
*L10nObjectDiff -> L10nObjDiff
*silme.format -> silme.fp
*get_l10npackage() -> get_l10npack()


2. Shorten words in names to max. 3 characters, like:
Ideas for changes in Silme 0.8:
*L10nObject -> LocObj
*Entity -> Ent
*EntityList -> EntLst
*L10nPackage -> LocPkg
*L10nObjectDiff -> LocObjDif
*silme.format -> silme.fp
*get_l10npackage() -> get_locpkg()


3. Shorten most of the names to max. 5 characters:
*L10nObject -> LObj
*Entity -> Ent
*EntityList -> EntL
*L10nPackage -> LPkg
*L10nObjectDiff -> LObjD
*silme.format -> silme.fp
*get_l10npackage() -> get_lpkg()


-------------------------------
For myself, I like the second one most (adriank)


== Gandalf ==
== In 0.7 ==


Two kinds of changes:
Amount of changes for Silme 0.7. We may want to incorporate some of those patterns for format/io in Silme 0.8.
* silme.core.Entity.get_value() -> silme.core.Entity.value
* silme.core.Entity.get_value('ab') -> silme.core.Entity['ab']
* silme.core.Entity.set_value('foo','ab') -> silme.core.Entity['ab'] = 'foo'
* silme.core.Entity.remove_value('ab') -> del silme.core.Entity['ab']
* silme.core.Entity.remove_value() -> del silme.core.Entity.value
* silme.core.EntityList.get_entity('id') -> silme.core.EntityList['id']


* Changes to class names:
(in above cases all get_value, set_value, remove_value still work, but the new syntax should be more handy)


** EntityList ->
Other changes:
** L10nObject ->
** L10nPackage -> Package
** EntityListDiff ->
** L10nObjectDiff ->
** L10nPackageDiff -> PackageDiff (?)


* Changes to methods names:
* silme.core.L10nObject -> silme.core.Structure
** all get_l10npackage -> get_package
* silme.core.L10nPackage -> silme.core.Package
** all get_l10nobject -> get_object
* silme.diff.entitylist -> silme.diff.list
** all get_entitylist -> get_list
* silme.diff.l10nobject -> silme.diff.structure
** all add_element -> add
* silme.diff.l10nobject.L10nObjectDiff -> silme.diff.StructureDiff
 
* silme.diff.L10nPackageDiff -> silme.diff.PackageDiff
== Axel ==
* silme.diff.package.L10nPackageDiff -> silme.diff.PackageDiff
 
* silme.diff.L10nPackageDiff -> silme.diff.PackageDiff
as on irc, none of 1) through 3). Cryptic shortcuts are just hard to remember. I think tha tost of the get_ foo can go. L10nPackageDiff can go to silme.package.diff (or are there any non-l10n packages in silme?).
* silme.core.EntityList.get_entity_ids -> silme.core.EntityList.ids
 
* silme.diff.PackageDiff.get_package -> silme.diff.PackageDiff.package
== stef ==
* silme.diff.PackageDiff.get_packages -> silme.diff.PackageDiff.packages
 
* silme.diff.PackageDiff.get_object_type -> silme.diff.PackageDiff.structure_type
I would suggest using '''only''' really good/common abbreviations/acronyms, like l10n, pkg, obj - names should be easy to read and understand in first place.
* silme.diff.PackageDiff.get_package_type -> silme.diff.PackageDiff.package_type
* silme.core.L10nPackage.packages -> silme.core.L10nPackage._packages
* silme.core.L10nPackage.objects -> silme.core.L10nPackage._structures
* silme.diff.PackageDiff.has_object -> silme.diff.PackageDiff.has_structure
* silme.core.Package.has_object -> silme.core.Package.has_structure
* silme.diff.PackageDiff.get_objects -> silme.diff.PackageDiff.structures
* silme.core.Package.get_package -> silme.core.Package.package
* silme.core.Package.get_packages -> silme.core.Package.packages
* silme.core.Package.get_objects -> silme.core.Package.structures
* silme.diff.EntityListDiff.get_entities -> silme.diff.EntityListDiff.entities
* silme.core.Package.get_object -> silme.core.Package.structure
* silme.core.EntityList.get_entities -> silme.core.EntityList.entities
Gandalf
Confirmed users
1,016

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/153553"

Navigation menu