php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #25189 Function lists in the manual showing the return type.
Submitted: 2003-08-21 09:04 UTC Modified: 2003-08-21 09:34 UTC
From: richard dot quadling at carval dot co dot uk Assigned:
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: Any
Private report: No CVE-ID: None
View Add Comment Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
You can add a comment by following this link or if you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: richard dot quadling at carval dot co dot uk
New email:
PHP Version: OS:

 

 [2003-08-21 09:04 UTC] richard dot quadling at carval dot co dot uk
Description:
------------
At the moment, you get this ...

Table of Contents
aspell_check_raw --  Check a word without changing its case or trying to trim it [deprecated] 
aspell_check -- Check a word [deprecated]
aspell_new -- Load a new dictionary [deprecated]
aspell_suggest -- Suggest spellings of a word [deprecated]


When would be REALLY useful is the return types and parameters. E.g.

Table of Contents
bool  aspell_check_raw ( int dictionary_link, string word) --  Check a word without changing its case or trying to trim it [deprecated] 
bool  aspell_check ( int dictionary_link, string word) -- Check a word [deprecated]
int   aspell_new ( string master [, string personal]) -- Load a new dictionary [deprecated]
array aspell_suggest ( int dictionary_link, string word) -- Suggest spellings of a word [deprecated]


Why?

When you are looking for a function that returns a type you can see what it may be called as sometimes the names are not what you expect.

NOTE: I used aspell as an example as it only had a few entries.

Regards,

Richard Quadling.


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2003-08-21 09:19 UTC] ali@php.net
As it says it is the TOC which usually does not give the user detailed information about the usage of the function, but states briefly what this function does.

If the function is needed for you to be used, you can just click on the link to get the doc-page of that special function which will also include the prototype-infos.

In my oppinion your request would just confuse and will not lead to a more userfriendly documentation.

any comments?
-ali
 [2003-08-21 09:24 UTC] richard dot quadling at carval dot co dot uk
I suppose you are right. It is just that I would like to see the function that gives the return type I want.

Often the return type and parameters suggest more about what the function does than its name.

Richard.
 [2003-08-21 09:27 UTC] didou@php.net
Is that what you need ? http://cvs.php.net/co.php/phpdoc/funcsummary.txt?login=2&r=1.22

didou
 [2003-08-21 09:30 UTC] richard dot quadling at carval dot co dot uk
Aha!

Pretty much bang on!

Thanks.

Richard.
 [2003-08-21 09:34 UTC] ali@php.net
I guess Mehdi's link solve your problem :)
Thus i'm setting the status to closed.

-ali

 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Sat Jun 15 21:01:28 2024 UTC