Posted by klonos on March 22, 2011 at 12:48pm
4 followers
Jump to:
| Project: | i18n auto translate |
| Version: | 6.x-2.x-dev |
| Component: | Miscellaneous |
| Category: | task |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | needs work |
| Issue tags: | coding standards, do not capitalize name |
Issue Summary
While at it for the d7 port, the project's name should be 'i18n auto translate' or 'L18n auto translate' instead of 'i18n Auto Translate'
Comments
#1
...or 'i18n auto-translate' I guess.
#2
Um, why? The lower casing of the 'i' in i18n is the normal way to write it and I always capitalise all first letters in my module titles (not that it really matters). It feels right to me.
#3
I know that i18n and i10n are written the way they are. I was referring to the "Auto Translate" part (it should be "auto translate"). Please see #1103208: Projects' names should be checked in .info files for correct capitalization. in the Coder module's queue. I explain why in more detail there + I point to the d.o article with the coding standards guidelines that dictates how module/theme names should be written.
I am aware that a lot of developers of contrib projects are accustomed in using Camel Casing, but that doesn't mean it is allowed by drupal coding standards. All core modules for example use the correct casing. I mean you don't see for example "Content Translation", "Database Logging" or "Update Manager" etc. Instead it is "Content translation", "Database logging" and "Update manager" etc. This is -IMHO- another bad habit like using tabs instead of double spaces and leaving trailing blanks at the end of lines. A lot of people would say that trying to eliminate these is pointless and argue that it doesn't make any difference in the code's end result, but we have coding standards in d.o and they must be followed - for good reasons too.
Now, there are of course exceptions for things like acronyms (SQL, UI, CCK etc) and I believe that i18n kinda falls under this category of permitted exceptions.
#4
I apologise, I did not know there was now a specific pattern to follow. I always capitalise my module names, so I'll have to change them all.
#5
No need to apologize mate ;)
...as I said, most people aren't familiar with that coding standard. So, a lot of people CamelCase their projects' names and because they do, others believe it is ok too. It's a vicious circle :/
...that's why I filed the issue in Coder. Lot's of people test their code using it and if there was some kind of warning, it would then help spread the word around.
I see you have almost 20 projects listed in your profile. That's a handful. Sorry, but you don't need to go and do it all at once now ;)
#6
Hehe, now I know they will be updated over time...
#7
I might be able to help with that task Greg (slowly as I find spare time in my life). You can just take care of the .info files, where a single line needs to be changed (for every branch of each of the modules I guess) + the projects' pages in d.o. while I can go through each of them and do a search & replace in help texts etc then provide patch files for you to review. Let me know.
#8
Fixed on the project page and updated the module info file too. Any other instances of this mistake, please re-open and point me at them. Thanks! =)
#9
Oops, closed fixed!
#10
See #1346158: Decide on coding standard for capitalization of module names [policy, no patch] and #1430452: Use Proper Name Case for core modules for current information on this policy.
#11
i agree that we should probably revert the name, based on the arguments listed in michelle's issues here.
#12
Arrrg, so I have to change it *back* again? ;-)
#13
...yep, the standard has changed and it now allows (more likely suggests) Proper Name Case instead of the Sentence case for module/theme names. The Sentence case policy remains for UI text like widget labels for example.
#14
@greg: I deliberately only linked to the issue as an FYI rather than change the status or title in order to leave it up to individual maintainers how they want to handle it. I'm not telling you that you have to do anything. :)
Michelle
#15
@Michelle, don't worry, I was only kidding - but I will change it. I prefer it the "new" way anyway! =)
#16
@greg.harvey: That's fine. :) I just wanted to be clear that my mass posting on all these issues was informational only. I'm not trying to tell any of the maintainers what to do; I'm merely ensuring they are aware of what has been going on in this area recently so they can make an informed decision.
Michelle