Make docs of drupal_realpath() match code. [#1192466]

Breaking this off from #1191236: Correct file_copy, file_move, file_save_data, and drupal_realpath to match documentation and their unmanaged counterparts.

The documentation for the $uri parameter to drupal_realpath() says, in part:

If this value is omitted, Drupal's default files directory will be used [public://].

However, this claim is untrue. Omitting the $uri parameter will actually result in a PHP warning, and the function will return FALSE.

Comment	File	Size	Author
#4	drupal_realpath-make_docs_match_code-1192466-4.patch	911 bytes	pillarsdotnet
#1	drupal_realpath-make_docs_match_code-1192466-1.patch	892 bytes	pillarsdotnet

Comments

Comment #1

pillarsdotnet commented 18 June 2011 at 05:31

Status	File	Size
new	drupal_realpath-make_docs_match_code-1192466-1.patch	892 bytes

This patch changes the docs to match the code.

Comment #2

pillarsdotnet commented 18 June 2011 at 05:31

Status:

Active

» Needs review

Comment #3

mr.baileys

Dutch

🇧🇪 (Ghent)

commented 18 June 2011 at 09:59

I think we should limit the change to just dropping the "If this value is omitted, Drupal's public files directory will be used [public://]." part. Technically, the value can't be omitted anyway, since it is a mandatory function argument. Granted, it can be an empty string, but then that's just an error on behalf of the calling code, and we don't babysit broken code...