[ nedit-Bugs-1902887 ] documentation bugs

[SourceForge.net]

Bugs item #1902887, was opened at 2008-02-27 02:15
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=111005&aid=1902887&group_id=11005

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Nobody/Anonymous (nobody)
Assigned to: Nobody/Anonymous (nobody)
Summary: documentation bugs

Initial Comment:
The attached patch corrects some bugs of the NEdit documentation.

a) The description of the dialog() subroutine is changed

from   dialog( message, btn_1_label, btn_2_label, ... )
  ... Additional optional arguments represent labels for buttons to appear along
  the bottom of the dialog. Returns the number ...

to     dialog( message [, btn_1_label, btn_2_label, ... ] )
  ... Additional optional arguments represent labels for buttons to appear along
  the bottom of the dialog. When optional arguments are omitted, the default
  "OK" button is used. Returns the number ...
  
The same is done for the list_dialog() and the string_dialog().

b) Missing descriptions are added for:
   last_document()
	next_document()
	previous_document()
	bg_menu_command()
	load_tips_file()
	unload_tips_file()
	nedit*calltip.fontList
	nedit.boldItalicHelpFont
	nedit.boldItalicFixedHelpFont
	
c) Broken hyperlink to Rangesets is corrected, see Table of Contents in
  nedit.html.
d) Broken formatting of descriptions of the menu actions is corrected.

The following problem is not covered by the patch.

The are four inconsistent descriptions:

process_down( ["nobell", "absolute"] ) ..............
process_shift_down( ["nobell", "absolute"] )
  Same as process_down("extend") for compatibility with previous versions.

process_shift_up( ["nobell", "absolute"] )
  Same as process_up("extend") for compatibility with previous versions.
process_up( ["nobell", "absolute"] ) ................
  
The process_down/up functions have no (?) "extend" option (see text.c).

Alexey Kuznetsov


----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=111005&aid=1902887&group_id=11005