bugGNU nano - Bugs: bug #52234, nano's bindable functions are not...

 
 

You are not allowed to post comments on this tracker with your current authentication level.

bug #52234: nano's bindable functions are not all documented

Submitter:  David Lawrence Ramsey <dolorous>
Submitted:  Mon 16 Oct 2017 12:25:15 AM UTC
   
 
Severity:  3 - Normal Status:  Fixed
Assigned to:  dolorous Open/Closed:  Closed

Wed 25 Oct 2017 03:54:51 PM UTC, comment #5: 

The macro functions were documented by commit 4d358351.  And the documented names of the bindable functions were made more consistent with your last patch, in commit 2356693b.  Thanks.

Benno Schulenberg <bens>
Group administrator
Thu 19 Oct 2017 08:02:39 PM UTC, comment #4: 

Thanks.

Attached a patch against git 4d35835 that updates the documentation for the other bindings.

(file #42197)

David Lawrence Ramsey <dolorous>
Group Member
Thu 19 Oct 2017 07:50:26 PM UTC, comment #3: 

1. is already the case, 2. yes, but 3. and 4... not so sure.  But okay, let's change those too.

The patch for runmacro and recordmacro has been applied, with tweaks.  Thanks.

Benno Schulenberg <bens>
Group administrator
Mon 16 Oct 2017 07:43:51 PM UTC, comment #2: 

For the macro functions, I figured you'd say that, so attached :)

As for the rest, given the names of the keys, and your commentary (which I generally agree with), I'd do this:

1. Make "speller" official, and "tospell" the alias.

2. Make "browser" official, and "tofiles" the alias.

3. Make "pageup" official, and "prevpage" the alias.

4. Make "pagedown" official, and "nextpage" the alias.

At least then, the key names are consistently the official ones, and in the cases where the key names diverge from the tags, the tags are the unofficial ones.  As long as nano continues to support both the official and unofficial bindings, nothing will change in terms of code, and the documentation will only need to be updated to reflect the new official names in these four cases.

And as for whether they need to be documented or not... as long as the tags keep the same names, fine.  I still don't particularly like undocumented features, but using the tag names is intuitive enough in these cases that I can deal with it.

Is this proposal acceptable?

(file #42170)

David Lawrence Ramsey <dolorous>
Group Member
Mon 16 Oct 2017 06:43:40 PM UTC, comment #1: 

Yes, recordmacro and runmacro still need to be documented.  Patch welcome.

For the movement stuff... I don't thinkt the aliasses need to be documented.  The first four are the "tags" that nano uses when showing these functions in the help lines.  The bindable functions for the page movement keys were missing until three years ago.  If I had thought a bit better then, I would probably have documented 'pageup' and 'pagedown' instead (and kept 'prevpage' and 'nextpage' as undocumented aliasses).

For 'speller' and 'tofiles' I... didn't think enouh when I documented the latter.  It should have been 'browser' in the documentation.  Don't know what to do about them now.  What do you suggest?

Benno Schulenberg <bens>
Group administrator
Mon 16 Oct 2017 12:25:15 AM UTC, original submission:  

I've gone through the list of bindings in global.c and compared them to the listings in the documentation (the manual page and the info page), and there are some missing entries.  These are as follows.  (The "recordmacro" and "runmacro" entries apply only to current git [58ecc03], since their status is based on brand-new code, but the others have been around longer.)

Completely undocumented bindings:

recordmacro
runmacro

Undocumented aliases for documented bindings:

tospell: alias for "speller"
back: alias for "left"
forward: alias for "right"
prevline: alias for "up"
nextline: alias for "down"
pageup: alias for "prevpage"
pagedown: alias for "nextpage"
browser: alias for "tofiles"

David Lawrence Ramsey <dolorous>
Group Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by bens (Posted a comment)
  • -email is unavailable- added by dolorous (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2017-10-25 bens StatusIn Progress Fixed
        Open/ClosedOpen Closed
    2017-10-19 dolorous Attached File- Added 0001-docs-properly-document-official-key-bindings.patch, #42197
    2017-10-19 bens StatusNone In Progress
        Assigned toNone dolorous
        Summarynano's key bindings are not all documented nano's bindable functions are not all documented
    2017-10-16 dolorous Attached File- Added 0001-docs-document-the-bindings-for-recordmacro-and-runma.patch, #42170

    Back to the top

    Powered by Savane 3.13-758e.
    Corresponding source code