Ticket #382 (new enhancement)

Opened 15 years ago

Last modified 15 years ago

Normalize product names and directory names (singular vs plural)

Reported by: madarche Owned by: bdelbosc
Priority: P3 Milestone: unspecified
Component: CPSDefault Version: unspecified
Severity: normal Keywords:
Cc:

Description

Bizarrement, on a les deux. Ex:

CPSSchemas, CPSNewsLetters, CPSSubscriptions

mais

CPSDocument, CPSForum, CPSChat...

Sans parler des API (i.e. nommage des classes et des méthodes, ordre des paramêtres), problème beaucoup plus vaste.

In faudrait être plus cohérents. En effet, en étant cohérent, on diminue l'effort de mémoire nécessaire pour utiliser l'API.

Change History

comment:1 Changed 15 years ago by madarche

Et puis il y a aussi des incohérences au niveau des msgid pour les traductions.

Pour CPSSchemas, les msgid de traduction ont plusieurs formes, cpsschema_xxx et cpsschemas_xxx : "cpsschema_at", "cpsschema_link_preview", "cpsschema_hour", "cpsschemas_image_resize", etc.

Nommer des répertoires ou des produits au pluriel n'apporte généralement aucune information supplémentaire et allonge donc inutilement les chemins.

Il faut plutôt comprendre le nommage d'un répertoire ou d'un produit comme le nom de la fonction réalisée ou des types d'objets contenus.

Donc personnellement j'apprécierais beaucoup que nous ayons les produits CPS avec un nommage au singulier : CPSDocument, CPSForum, CPSChat, CPSSchema, CPSNewsLetter, CPSSubscription, etc.

De la même manière, lorsqu'on crée un répertoire pour la documentation, je pense que cela est mieux de le nommer "doc" et non "docs".

Pour comprendre cette démarche, je vous invite à imaginer un système Unix avec le nommage suivant : /homes/ /usr/libs/ /usr/shares/ /usr/srcs/ /usr/share/docs/ etc.

=> :-(

On a bien également /var/lib/zope2.7xxx/instance/<mon_instance> et non /var/lib/zope2.7xxx/instances/<mon_instance>

Par contre /usr/games/ existe, mais cela m'a toujours choqué.

Je suis prêt à mettre à jour les guides sur la question

Le seul argument pour l'utilisation du pluriel est que c'est peut-etre plus intuitif ("docs" = une liste de (plusieurs) documents), mais comme ce nommage est utilisé par des personnes à profils techniques, ce n'est pas vraiment un argument.

comment:2 Changed 15 years ago by bdelbosc

agree to use singular for CPS new products and directory but cmf/zope/python don't follow this unix rule:

CMF: skins tests Extensions interfaces images scripts

nor zope: find . -type d -name '*s' * tests ./ZConfig/scripts ./nt_svcutils ./Shared/DC/Scripts ./ZTUtils ./ZServer/medusa/docs ./StructuredText?/regressions ./zExceptions ./Products ./Products/ZGadflyDA/icons ./Products/OFSP/images ./Products/MIMETools ./Products/PageTemplates? ./Products/PageTemplates?/examples ./Products/Sessions? ./Products/PluginIndexes? ./Products/StandardCacheManagers? ./Products/PythonScripts? ./Products/PythonScripts/Extensions? ./Products/ZSQLMethods ./Products/SiteAccess? ./Products/SiteAccess/Extensions? ./ZClasses ./Signals ./docutils ./docutils/languages ./docutils/transforms ./docutils/readers ./docutils/parsers ./docutils/parsers/rst/languages ./docutils/parsers/rst/directives ./docutils/writers ./HelpSys? ./HelpSys?/images ./BTrees

nor python: ./doc/tools ./doc/texinputs ./doc/templates ./xml/parsers ./distutils ./encodings ./curses ./site-packages ./site-packages/ctypes

comment:3 Changed 15 years ago by madarche

  • Cc sf@… added

You are right Benoit and it is a shame and just sad in the end.

But anyway Zope/CMF don't use the mixed cased rule for all its methods while CPS follow this rule everywhere.

It's not because Zope/CMF is dirty, at least in some places, that we should do the same for CPS.

comment:4 Changed 15 years ago by fguillaume

  • Priority changed from P2 to P4

Moving to P4.

comment:5 Changed 15 years ago by bdelbosc

  • Priority changed from P4 to P3

P3 as we don't use P4 or P5

Note: See TracTickets for help on using tickets.