search

da4089 / simplefix

Simple FIX protocol implementation for Python
MIT License
229 stars 63 forks source link

Updating documentation #27

Closed JonathonMurphy closed 4 years ago

JonathonMurphy commented 4 years ago

I've been working with simplefix to create an application to pull security definitions from ICE, and I thought I would take a stab at updating/adding to your documentation.

I made a few small corrections to the import.rst file to match the current class names. I also changed all instances of a FixMessage() to a consistent 'message' variable name. The largest edit is to the 'parsing.rst' file. I added code examples for the FixParser() class and examples of how to use it's methods.

coveralls commented 4 years ago

Coverage Status

Coverage remained the same at 95.968% when pulling 8753f393ffb5613be5328b602b161f348b60dc35 on JonathonMurphy:master into aaa1263e348ee8e54f0621a1814491c52362925b on da4089:master.

coveralls commented 4 years ago

Coverage Status

Coverage remained the same at 95.968% when pulling 3e62d8acbb0941f35e531040658fce9150635433 on JonathonMurphy:master into aaa1263e348ee8e54f0621a1814491c52362925b on da4089:master.

da4089 commented 4 years ago

hi Jonathon -- thanks for the PR!

Looks good, except I think lines 18 & 19 of parsing.rst need checking: append_buffer() doesn't return anything, and the get_message() should be on the parser?

If you can tweak that, I'll merge it ASAP.

Thanks again!