Open Stack

Hi Anita, 

Is this an area where a new developer can help out?

I've got a little time to spare (not a whole lot, best-effort...) and would like to help out. I'm very new to all of this though.
I figure that documenting code is a good way to contribute and learn at the same time.
Could anyone point me to a simple class that could benefit from this? I'll probably need some help getting it through the system (never submitted a patch for Openstack before).

Thanks!

Joris

-----Original Message-----
From: Anita Kuno [mailto:anteaya at anteaya.info] 
Sent: Tuesday, November 12, 2013 01:50
To: OpenStack Development Mailing List
Subject: [openstack-dev] [Neutron]Good example of dev doc/docstrings in code.

Hello:

I will be creating noise around testing in order to help shore up the gap between where we are in Neutron and where everybody agrees we would like to be.

To that end I would like to point out a great example of docstrings in code:
https://github.com/openstack/neutron/blob/master/neutron/neutron_plugin_base_v2.py

which is used to generate dev docs.

Here are the generated docs from the above docstrings in the code:
http://docs.openstack.org/developer/neutron/devref/plugin-api.html

The docstrings are great for the author of the patch to ensure the purpose of each method/function is clearly understood by themselves, reviews and users of the code.

I would like to encourage current and future patches to include good docstrings/dev docs going forward.

Thanks everyone for your support helping to close the gap with testing with Neutron.

Thank you,
Anita Kuno
anteaya

_______________________________________________
OpenStack-dev mailing list
OpenStack-dev at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev