Opened 5 years ago

Last modified 5 years ago

#3953 enhancement new

twisted.positioning howto documentation

Reported by: lvh Owned by: lvh
Priority: normal Milestone:
Component: core Keywords:
Cc: thijs Branch: positioning
(diff, github, buildbot, log)
Author: Launchpad Bug:

Description

twisted.positioning, at time of writing still in development, should get documentation as soon as the API stabilizes.

Change History (4)

comment:1 Changed 5 years ago by lvh

More reviewing goodness:

t.p.nmea.NMEASentence properties. How do you do these properly? There's a suggestion by yours truly in the added patch, but I'm not entirely sure that's the proper way to handle them. For example, that raises KeyError instead of AttributeError -- and I'm not even sure if we should raise AttributeError or keep the current behavior of "if you don't know, return None".

comment:2 Changed 5 years ago by lvh

Disregard that last comment, attached to the wrong ticket.

comment:3 Changed 5 years ago by greywulf

Proposal for some documentation:
================================

A demo has already been shown here:
http://twistedmatrix.com/pipermail/twisted-python/2009-August/020291.html
http://paste.pocoo.org/show/136539/

I propose adding a directory examples to twisted.positioning which would contain
nmealog.txt
nmea.py
positioning.py

nmea.py and positioning.py would be shell executables, so you could call
./nmea.py nmealog.txt

output would be as in
http://paste.pocoo.org/show/136539/

positioning.py would do the same, but demonstrate the 'positionreceived', 'altitudereceived' methods instead of rawer data.

Both examples can have documentation explaining proper usage of twisted.positioning.

If this proposal conflicts with any selected conventions of twisted, feel free to reformat.

comment:4 Changed 5 years ago by thijs

  • Author lvh deleted
  • Cc thijs added
  • Owner changed from glyph to lvh

Assigning to lvh since he's working on t.positioning.

Note: See TracTickets for help on using tickets.