A Thursday 02 December 2010 17:57:34 david.bri...@ubs.com escrigué:
> Hi
> 
> I've found it useful to make the distinction between an index and an
> offset in code and documentation as they are unambiguous. Typically C
> programmers think in terms of offsets but they call them indexes,
> which then means the audience has to think about what is meant.
> 
> It may be (as in I would find it ;o) ) helpful to make that
> distinction in the pytables documentation. I just spend a while
> tracking down a bug that calculated an index (as in the first
> element, the second element, ... the last element) when an offset
> was required (i.e. start + 0, start + 1, ..., start + (N-1) ).

Uh, could you point to some of the affected docstrings?

> The use of the term index is further confused with the indexes for
> sorting!

Yeah, but these both conventions are *very* extended, and there is 
little that can be done here.  But at least in this case the distinction 
is easier if the context is taken in account.

Cheers,

PS: Please do not hijack the threads of others.  That introduces 
confusion in readers that classify messages by thread.  Whenever you 
want to introduce a new subject, always post to the list directly.

-- 
Francesc Alted

------------------------------------------------------------------------------
Increase Visibility of Your 3D Game App & Earn a Chance To Win $500!
Tap into the largest installed PC base & get more eyes on your game by
optimizing for Intel(R) Graphics Technology. Get started today with the
Intel(R) Software Partner Program. Five $500 cash prizes are up for grabs.
http://p.sf.net/sfu/intelisp-dev2dev
_______________________________________________
Pytables-users mailing list
Pytables-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/pytables-users

Reply via email to