← Back to issue list

Writing snapcraft plugins is hard due to lack of API documentation

View original Launchpad issue

Metadata

Project
snapcraft
Number
#1599711
Type
issue
State
open
Author
~thomir-deactivatedaccount
Labels
snap-docs
Created
2016-07-07 03:43:34.354362+00:00
Updated
2017-03-04 19:57:00.915253+00:00
Closed

Current evaluation

No evaluation has been recorded for this issue yet.

Issue body

I find myself having to write a custom plugin, and it's really hard to know what I should be doing in each method of BasePlugin. It would be nice if there was comprehensive API documentation aimed at plugin authors, published online. Ideally it would cover: * Which methods of BasePlugin can be overridded. * What plugin authors should do in each method. * which attributes are set on the BasePlugin, and what they're for (installdir, builddir etc). * When each method on BasePlugin will get called. * Functions, classes and methods from the rest of snapcraft that's considered a public, stable API.

Evaluation history

No evaluation history available.