1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-11-02 08:57:19 -04:00

Python: Document more goto_url_hook and follow_url_hook return values.

Document what happens if goto_url_hook or follow_url_hook returns None or "".
doc/events.txt already explains the corresponding C values.

[ commit message by me --KON ]
This commit is contained in:
M. Levinson 2007-01-06 07:30:32 -05:00 committed by Kalle Olavi Niemitalo
parent 8b8bb5610f
commit ec1bedc25e
2 changed files with 8 additions and 4 deletions

View File

@ -49,7 +49,8 @@ dumbprefixes = {
def goto_url_hook(url): def goto_url_hook(url):
"""Rewrite a URL that was entered in a "Go to URL" dialog box. """Rewrite a URL that was entered in a "Go to URL" dialog box.
This function should return a URL for ELinks to follow, or None if This function should return a string containing a URL for ELinks to
follow, or an empty string if no URL should be followed, or None if
ELinks should follow the original URL. ELinks should follow the original URL.
Arguments: Arguments:
@ -63,7 +64,8 @@ def goto_url_hook(url):
def follow_url_hook(url): def follow_url_hook(url):
"""Rewrite a URL for a link that's about to be followed. """Rewrite a URL for a link that's about to be followed.
This function should return a URL for ELinks to follow, or None if This function should return a string containing a URL for ELinks to
follow, or an empty string if no URL should be followed, or None if
ELinks should follow the original URL. ELinks should follow the original URL.
Arguments: Arguments:

View File

@ -37,7 +37,8 @@ FUNCTIONS
follow_url_hook(url) follow_url_hook(url)
Rewrite a URL for a link that's about to be followed. Rewrite a URL for a link that's about to be followed.
This function should return a URL for ELinks to follow, or None if This function should return a string containing a URL for ELinks to
follow, or an empty string if no URL should be followed, or None if
ELinks should follow the original URL. ELinks should follow the original URL.
Arguments: Arguments:
@ -47,7 +48,8 @@ FUNCTIONS
goto_url_hook(url) goto_url_hook(url)
Rewrite a URL that was entered in a "Go to URL" dialog box. Rewrite a URL that was entered in a "Go to URL" dialog box.
This function should return a URL for ELinks to follow, or None if This function should return a string containing a URL for ELinks to
follow, or an empty string if no URL should be followed, or None if
ELinks should follow the original URL. ELinks should follow the original URL.
Arguments: Arguments: