I disagree, for addons which users directly use there should be some
form of documentation in the wiki. But for script.modules pydocs should
be more than sufficient for anyone writing code (This modules looks to
have great pydocs). If you want you can generate HTML based docs from
the pydoc pretty easily.
Paddy
On 12/02/12 16:25, Martijn Kaijser wrote:
Agreed.
Every add-on in official repo already gets its own wiki page.
All add-on devs should update it with all info and examples on how to
use it and easy to find for every one.
Here's mine for example:
http://wiki.xbmc.org/index.php?title=Add-on:Artwork_Downloader
Regards,
Martijn
Op 12 feb. 2012 17:15 schreef "Viljo Viitanen"
<[email protected] <mailto:[email protected]>> het volgende:
Hey,
A request to you, and everyone else doing similar stuff: Please
provide an url for at least *some* documentation in addon.xml
description or elsewhere where it's easily found. I actually wish it
was mandatory for addons meant for common use to be included in the
xbmc addons repo.
Here methods have descriptions in source, but no examples are given.
Github project doesn't have a readme (btw see github CTO's view on
readmes:
http://tom.preston-werner.com/2010/08/23/readme-driven-development.html
). Forum and google search with some guessed terms come up with
nothing relevant.
Having to read the source to know how to use the modules just isn't
the way to go.
Viljo Viitanen
2012/2/8 Mike M <[email protected] <mailto:[email protected]>>:
> Hi, my first pull request
>
> Common library for XBMC Addons initially created by t0mm0 - a
collection of
> common methods to simplify addon development
>
> * addon - script.module.t0mm0.common
> * version - 1.0.0
> * url -
git://github.com/Eldorados/script.module.t0mm0.common.git
<http://github.com/Eldorados/script.module.t0mm0.common.git>
> * revision - 7edc79d705a087c7b8909d9134ba6b5e05e9ee5f
> * branch - master
> * xbmc version - dharma/eden
>
> Changelog:
> 1.0.0
> - Initial Release
>
>
> thanks,
> Mike (Eldorado)
>
>
>
------------------------------------------------------------------------------
> Keep Your Developer Skills Current with LearnDevNow!
> The most comprehensive online learning library for Microsoft
developers
> is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5,
CSS3, MVC3,
> Metro Style Apps, more. Free future releases when you subscribe now!
> http://p.sf.net/sfu/learndevnow-d2d
> _______________________________________________
> Xbmc-addons mailing list
> [email protected]
<mailto:[email protected]>
> https://lists.sourceforge.net/lists/listinfo/xbmc-addons
>
--
Viljo Viitanen
[email protected] <mailto:[email protected]>
------------------------------------------------------------------------------
Virtualization & Cloud Management Using Capacity Planning
Cloud computing makes use of virtualization - but cloud computing
also focuses on allowing computing to be delivered as a service.
http://www.accelacomm.com/jaw/sfnl/114/51521223/
_______________________________________________
Xbmc-addons mailing list
[email protected]
<mailto:[email protected]>
https://lists.sourceforge.net/lists/listinfo/xbmc-addons
------------------------------------------------------------------------------
Virtualization& Cloud Management Using Capacity Planning
Cloud computing makes use of virtualization - but cloud computing
also focuses on allowing computing to be delivered as a service.
http://www.accelacomm.com/jaw/sfnl/114/51521223/
_______________________________________________
Xbmc-addons mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/xbmc-addons
------------------------------------------------------------------------------
Virtualization & Cloud Management Using Capacity Planning
Cloud computing makes use of virtualization - but cloud computing
also focuses on allowing computing to be delivered as a service.
http://www.accelacomm.com/jaw/sfnl/114/51521223/
_______________________________________________
Xbmc-addons mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/xbmc-addons
