Missing documentation for FAPI #access for 5.x on api.drupal.org
rszrama - July 9, 2008 - 15:03
| Project: | Drupal |
| Version: | 5.x-dev |
| Component: | documentation |
| Category: | bug report |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed |
Description
I stumbled across #access largely by accident while developing a module and was very happy to have found it. I'm using it to disable CCK fields when non-administrators create certain nodes, but I couldn't find any documentation to know if this is going to have unintended side effects.
It looks like this is because my module was for 5.x, and the FAPI reference makes no mention of it for that version. I do see info now in the 6/7 versions of the reference, so I'm curious if we can "back port" that documentation.
#1
>I do see info now in the 6/7 versions of the reference, so I'm curious if we can "back port" that documentation
Yes that would be a good idea! #access is very much present and active in D5.
Here's a link to the D6 info on it, for reference http://api.drupal.org/api/file/developer/topics/forms_api_reference.html....
#2
Yep, anyone with a CVS account can do this. Just copy/paste the stuff out of the Drupal 6 docs, and do a checkout of -r DRUPAL-5 contributions/docs/developer and commit there.
Thanks!
#3
yeah, but I don't have CVS access ..!
Guess I could do a patch tho.. ;-) or would a new/fresh/updated copy of forms_api_reference.html be more use?
#4
No, a patch would be lovely! That way people can easily see exactly what's being changed. :)
Incidentally, if you or someone else wanted to get a CVS account for the sole purpose of maintaining the docs, I would definitely +1 that. Most of the developers have other things they're working on. ;(
#5
Thanks webchick, I'll see what I can do when I have a mo.
:-D
#6
hah, I had no clue I could just update that myself. : )
If gpk doesn't get to it first, I've got CVS access and can take care of it. If I do make updates like this, should I file issues/patches for each update or just commit them with good messages?
#7
I would do both committing them and uploading a patch here for posterity, please. Thanks!
#8
Bleurgh, I've not patched docs before... hope this patch applies OK! Content is copied directly from the D6 version.
#9
#10
Patch failed to apply. More information can be found at http://testing.drupal.org/node/13897. If you need help with creating patches please look at http://drupal.org/patch/create
#11
The bot can't seem to cope with documentation not in Drupal core ...
#12
No. Its HTML documentation, available from CVS.
#13
Hmmm if I've understood recent changes correctly the previous classification was actually correct - they've all been moved over en masse in an effort to get documentation issues dealt with more quickly. http://drupal.org/node/301443
#14
Patch in #8 commited, thanks.
#15
Just noticed I copied the erroneous "TRUE of FALSE" from the D6 documentation. In both cases this should be "TRUE or FALSE". Committed minor change accordingly. Cheers, heyrocker.
#16
Thanks for fixing that on all 3 relevant branches (D5, 6, 7).
:D
temp
Automatically closed -- issue fixed for two weeks with no activity.
#17
Automatically closed -- issue fixed for two weeks with no activity.