[bug #43042] Texinfo manual typo and improvement in info node 'Node Line Requirements'

[Vincent Belaïche]

URL:
  <http://savannah.gnu.org/bugs/?43042>

                 Summary: Texinfo manual typo and improvement in info node
'Node Line Requirements'
                 Project: texinfo - GNU documentation system
            Submitted by: vincentb1
            Submitted on: jeu. 21 août 2014 17:22:14 GMT
                Category: None
                 Release: 
                Priority: 5 - Normal
                Severity: 3 - Normal
              Item Group: None
                 Privacy: Public
             Open/Closed: Open
             Assigned to: None
         Discussion Lock: Any
                  Status: None

    _______________________________________________________

Details:

= References = 
See bug report on EMACS info viewer
<http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18308#11>.

= Position of problem = 

In texinfo manual info node `(texinfo) Node Line Requirements', one can read
the following:


     all define the same node, namely 'foo bar'.  References to the node
     should all use that name, with no leading or trailing spaces a
     single internal space.


= Missing *and* = 

I think that it should read `with no leading or trailing spaces *and* a single
internal space'.

= Clarifying _References_ = 

Furthermore, what _References_ means it a bit ambiguous. I understand that it
means references in the texinfo manual source code, and that it is one of the
following:

* a @ref, @xref, or @pxref
* a menu entry

= Making a separate item = 

Finally, the stance about space handling, is in the same item as case
sensititivity. I think it would improve the manual if a separate item.

= Node title = 

Title speaks about "node line", but the scope of the node is wider, it is
about node names in general, not only within a node line. I am not sure wether
it is wise to change the node name because it may be used for reference
elsewhere, but the section title should be about '@node' Line Requirements _,
and node naming_.







    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?43042>

_______________________________________________
  Message posté via/par Savannah
  http://savannah.gnu.org/