Skip to content
This repository has been archived by the owner on Oct 27, 2019. It is now read-only.

Commit

Permalink
Added further description of goto's functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
onecrayon committed Jun 24, 2009
1 parent 2b77c60 commit e059658
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions src/TEA/goto.py
Expand Up @@ -4,24 +4,31 @@

import tea_actions as tea

def act(context, target=None, source=None, prompt=None, search_string=None,
regex=False):
def act(context, target=None, source=None, trim=False, discard_indent=False,
prompt=None, search_string=None, regex=False):
'''
Required action method
target dictates what we're looking for:
- text
- zone (by syntax zone selector string)
- zone (syntax zone selector string)
- if unspecified, simply selects the source
source dictates how to gather the string to search for:
- user (user will be prompted to enter a string)
- selection
- word (word under the caret)
- line (line under the caret)
Setting trim=True will cause the source to be trimmed
Setting discard_indent=True will cause even indentation characters
to be trimmed (unnecessary unless trim=True)
prompt will set the text of the dialog box if source='user'
search_string will set the string to search for if target is text or zone;
$SELECTED_TEXT will be replaced with the source text
search_string will set the string to search for if target is text or zone
- $SELECTED_TEXT will be replaced with the source text
Setting regex=True will cause search_string to be evaluated as regex
'''
Expand Down

0 comments on commit e059658

Please sign in to comment.