pytm icon indicating copy to clipboard operation
pytm copied to clipboard

Missing documentation for conditions

Open colesmj opened this issue 6 years ago • 5 comments

Some properties/conditions are obvious and don't really need documentation, such as protocol or isEncrypted. But other properties may not be obvious to some, such as Dataflow.authenticatedWith - with what?

colesmj avatar Oct 21 '18 15:10 colesmj

@shambho Does your commit 3 days ago resolve this issue? If so, let's close this one. Alternately, or maybe also, we should document the object model on the wiki. I had put one up there a long time ago, but it is no longer valid, so I will deprecate it (I'd like to keep it around for some future looking work).

colesmj avatar Apr 24 '19 23:04 colesmj

@colesmj nope. Commit from 3 days ago was about adding some cosmetic changes to tm.py, Readme and pytm.py. Agree, we should have more documentation on the properties available in each Class.

shambho avatar Apr 26 '19 20:04 shambho

#91 documents a very small subset of attributes.

nineinchnick avatar Mar 22 '20 11:03 nineinchnick

I would like to second this issue report: flags such as "sourceFiles" are not clear to the average user/reader, without explanation.

cptfixit avatar Dec 18 '22 09:12 cptfixit