search

ntoll / drogulus

A programmable peer-to-peer data store built for simplicity, security, openness and fun (and designed to withstand nuclear war).
http://drogul.us
Other
196 stars 21 forks source link

Implementing handle_value function in node.py #3

Closed ciaranmooney closed 11 years ago

ciaranmooney commented 11 years ago

After reading CONTRIBUTE I suppose this is a better way to help out.

I have decided to try and implement the handle_value method of the Node class in node.py. This has meant the creation of some new methods in the Node class, but they haven't been fleshed out yet.

I am of course writing associated tests.

Currently being worked on in my implement_handle_value branch (soon to be renamed implement_handle_value_3)

ntoll commented 11 years ago

Hey,

Hmm... the handle_value method relies on a block of code I'm currently implementing and will push later this week.

Best wait for that to land first. In the meantime, if you're looking for something to do you could take a look at the documentation (in the docs directory). You'll need sphinx to build it (which isn't in the requirements.txt file) and I'd be interested to see how you get on.

Specifically, I'm sure you've noticed I've created lots of docstrings which should be automatically built by sphinx into some sort of useful document. It'd be good to know this works and that the results are understandable. This would also have the secondary (and hugely useful) result of becoming familiar with the code structure via the docs.

Does this make sense..? I can create a ticket if you like.

Getting the documentation right is very important for me, especially when it comes to making the docs understandable to people who are new to the project.

Happy to help and answer questions. :-)

As always, all feedback, comments, suggestions and ideas most welcome!

N.

ciaranmooney commented 11 years ago

Hi,

One of the reasons of creating the ticket was to make sure I wasn't clashing, as I had a feeling you might be working on it.

I'm not fussed about the time that I "wasted" on the code, I didn't write much and learnt a lot more reading over the code and having to look things up about Twisted and MagicMock() so it was still a worthwhile endeavour.

I won't bother working on my local branch, but please take a look and see if there's anything useful to you (there's not much there).

I did notice and really appreciate all the doc strings and the tests. I don't think I'd got as far as I have without them. I wouldn't have mind having a crack at sphinx. If you could create a ticket for the sphinx testing that'd be great.

Speaking as a novice, the newer CONTRIBUTE file was very helpful, but it would be great if you raised a ticket (or some kind of public note) about which areas you're working on currently so that others don't dive in like me and duplicate effort.

Long live the docs!

Ciarán

ntoll commented 11 years ago

Hi,

See https://github.com/ntoll/drogulus/issues/4 :-)

Basically, I'm currently working on node.py.

N.

ntoll commented 11 years ago

I'll fix this now that NodeLookup class is more-or-less done.