Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Issue tags:
Reporter:
Created:
11 Oct 2008 at 17:31 UTC
Updated:
2 Jan 2014 at 23:45 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
lilou commentedComment #2
snufkin commented- @file to update.module's .install file
- re-rolled against head
- corrected typo for locale.install, profile.install
Overall it looks good to me, all core install files are affected, and all contain the correct text in their install file saying that
and uninstall where its relevant. One might want to polish the explanation text, but thats the only reason I am leaving it on CNR, otherwise its good to go.
Comment #4
lilou commentedfailure was due to HEAD not installing properly
Comment #5
catchI think we'd be better off finding a generic string we can use for every file - updates come and go for core modules each release and we don't want to keep changing the @file every time we add/remove one.
Comment #6
dave reid"Install, update and uninstall functions for the [module-name] module."? Just an idea since core currently uses "Admin page callbacks for the [module-name] module." in module.admin.inc files.
Comment #7
webchickThis would be a good issue for a new contributor to solve.
Comment #8
lilou commentedI'm a novice ;-)
Comment #9
karschsp commentedHere's a patch using DaveReid's suggested text from @#6.
steve
Comment #11
lilou commentedReroll.
Comment #12
lilou commentedRelated : #263956: Ye Grande Olde Drupal 7 .install File Cleanup
Comment #14
lilou commentedMark as duplicate, see #263956: Ye Grande Olde Drupal 7 .install File Cleanup
Comment #15
deekayen commented@lilou: It would probably be easier for you to get the @file part fixed first. Doing all the things in #14 in one patch is going to be hard to keep up to date. Are you willing to finish this out?
Comment #16
catchSending for re-test.
Comment #17
lilou commented@deekayen : ok, waiting reviews now tests passes.
Comment #18
catchLooks good, let's get this in.
Comment #19
webchickThis patch makes me all warm and happy on the inside. :D
Committed to HEAD. Thanks!
We should document this in the coding standards, and the D6 -> D7 upgrades page.
Comment #20
lilou commentedI add info to D6 -> D7 upgrades page.
Comment #21
catchComment #22
lilou commented@file is already include in coding standard.
Comment #23
catchI think we crossposted, definitely fixed.
Comment #24
xanoIs this just about using @file or about putting the code as mentioned here in install files? If it's the latter, could we please for the sake of professionalism stop using "The xxx module"? That is exactly the same as saying "The Volkswagen car" or "The Dries human". Modules have names, so let's use them directly, possibly suffixed with ".module" to prevent confusion.
Comment #25
lilou commented@Xano : look at http://api.drupal.org/api/files/7
examples of @file tags :
Admin page callbacks for the aggregator module.
Fetcher functions for the aggregator module.
Install, update and uninstall functions for the aggregator module.
User page callbacks for the aggregator module.
Parser functions for the aggregator module.
...
I have a Volkswagen car ;-)
Comment #26
webchick"Saturn" can be a car or a planet or a video game system. ;) It's nice to be specific. Plus some things such as menu and path can refer to both modules and also underlying parts of the system.
I also edited http://drupal.org/node/1354 to make specific mention of .install files following their own template rules for @file. I think this is really fixed now.