[tahoe-lafs-trac-stream] [tahoe-lafs] #1534: Some docs in mutable/layout.py are slightly confusing.

[tahoe-lafs]

#1534: Some docs in mutable/layout.py are slightly confusing.
--------------------------------+---------------------------
 Reporter:  zancas              |          Owner:  zooko
     Type:  defect              |         Status:  new
 Priority:  minor               |      Milestone:  undecided
Component:  code-mutable        |        Version:  1.9.0a1
 Keywords:  docs review-needed  |  Launchpad Bug:
--------------------------------+---------------------------
 I'm looking at layout.py.  There're three (minor) points of confusion for
 me in the docs.

   * 1:  On (or about) line 27 the docs assert that the 16-byte random
 value of the read-key salt is stored as a set of 16 characters, but I
 believe that "characters" have context dependent size.  So C-chars are 1
 byte in size, as are some implementations of Python string elements which
 I tend to think of as "characters", but this is implementation dependent
 and not future proof, right?

   * 2:  On (or about) line 38 there's a reference to "padding" I haven't
 figured out what this padding is.   Pointers and/or clarification
 appreciated.

   * 3:  On (or about) line 46 there's a reference to "this".  If
 understand the line correctly "this" is "HEADER additions", but I'm only
 83% confident.  I vote "this" is replaced with its referee.

-- 
Ticket URL: <http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1534>
tahoe-lafs <http://tahoe-lafs.org>
secure decentralized storage