Browse Source

Some doc fixes

master
Julio Biason 15 years ago
parent
commit
6ffd6343e6
  1. 8
      HACKING

8
HACKING

@ -1,6 +1,6 @@
================== =========================
How to hack Mitter Mitter Hacking Guidelines
================== =========================
First of all, Mitter is a Python project and it tries to follow PEP8_ First of all, Mitter is a Python project and it tries to follow PEP8_
as close as possible. Sometimes, we fail, but we try to adhere to it as close as possible. Sometimes, we fail, but we try to adhere to it
@ -61,10 +61,12 @@ you don't need anything).
__init__(self, connection, options) __init__(self, connection, options)
----------------------------------- -----------------------------------
The initialization will receive two parameters: The initialization will receive two parameters:
- connection: the network connection. Your interface will request any - connection: the network connection. Your interface will request any
network data with that object. You can check the ``Networks`` object network data with that object. You can check the ``Networks`` object
in the ``mitterlib/network/__init__.py`` for methods there (or read in the ``mitterlib/network/__init__.py`` for methods there (or read
the Sphinx documentation generated about it.) the Sphinx documentation generated about it.)
- options: It's a ConfigOpt_ object, with all your interface options. - options: It's a ConfigOpt_ object, with all your interface options.
Use it for EVERTYHING that you'd hardcode. Use it for EVERTYHING that you'd hardcode.

Loading…
Cancel
Save