Posted by theborg on February 26, 2008 at 4:06pm
Jump to:
| Project: | API |
| Version: | 5.x-1.x-dev |
| Component: | Code |
| Category: | feature request |
| Priority: | normal |
| Assigned: | theborg |
| Status: | postponed (maintainer needs more info) |
Issue Summary
This week on #drupal someone requested for tooltips on function listings. I think this is a good improvement and this is the patch to get them.
| Attachment | Size |
|---|---|
| api_tooltips.jpg | 126.89 KB |
| api_tooltips.patch | 9.63 KB |
Comments
#1
+1 for this feature.
#2
This patch very much no longer applies cleanly. It has been low-priority as a feature.
I personally do not like tooltips. When you load a page, the mouse is likely to be on the page. If the mouse happens to be on a tooltip, then you get the tooltip obscuring content. I really don't like my content obscured without me doing anything. In this specific case, maybe the whole function signature should be displayed, so users can see the arguments up-front.
This should be implemented well-enough that people will not want to turn it off, making the option unnecessary.
#3
These aren't tool tips by the way, they are link titles...
Anyway, that aside I was going to say that it seems like a more reasonable link title would be what we use for function links within documentation and code, which is the function's one-line description (that already exists). However, we already have this information on the Functions listing page in columns, so making it also the link title doesn't make sense to me.
I agree with drumm that putting the whole documentation in the link title doesn't make sense, and having these pop up all over would be annoying.
I don't think that the signature/arguments as link title would really add a whole lot to the browsing experience... but if someone wants to make a patch that does that, it looks like neither drumm nor I would object strenuously.
I will also point out that I can't find anything similar on other API doc sites to use as a model. None of these have useful link titles:
http://us2.php.net/manual/en/ref.strings.php
http://download.oracle.com/javase/6/docs/api/
http://docs.python.org/library/functions.html
http://www.w3schools.com/jsref/jsref_obj_global.asp
If you can find another API-type site that does something useful so we could look at it and evaluate, maybe that would help convince us that this is a good idea? Until then, I would say this is postponed.