On 08/01/12 10:58, Alex Railean wrote:
> Bad news: Well, I can't promise a release date at the moment. I
> need to spend some quality time with the docs:)
I can help with that. If you tell me which parts of the documentation
need to be updated, I can contribute to the areas in which I have
competence.
Hello Alex,
Thanks a lot for the offer. I'm doing a few things with the docs:
1) I'm re-reading everything and tweaking as appropriate. (e.g.
https://github.com/arskom/spyne/commit/72c5202f477d002f95695e4753be789a3935e62e)
2) I'm revising docstrings and adding/removing them as appropriate.
Docstring'd modules and functions show up in the library reference, thus
are part of the public api. As the public api will get frozen with this
release, this is an important task.
I'll release once I'm satisfied with the amount of work that went to
those points. Then:
1) I'll document undocumented features that was added with this release.
E.g. the spyne.auxproc package, or the new Twisted integration, etc.
Nobody uses these yet, so having docs for them is not that critical :)
2) I'll work on adding a "Spyne tips" chapter which contains non-obvious
ways of using spyne tools. The mailing list archive is actually a
treasure of such examples :) For example, to set a default namespace,
you should define your own ComplexModel like this:
class MyComplexModel(ComplexModelBase):
__metaclass__ = ComplexModelMeta
__namespace__ = 'my_awesome_namespace'
and base your classes on this model. This is obvious when you actually
think about it, but not totally obvious for people who are not
intimately familiar with spyne.
As for your question; Well, initially you can help with the introductory
tutorials. If you can proofread and verify that examples still work the
way the docs claim, I can focus on the second point. But of course, it's
totally up to you, every little would help.
Thanks a lot and best regards,
Burak
_______________________________________________
Soap mailing list
[email protected]
http://mail.python.org/mailman/listinfo/soap
