Writing snapcraft plugins is hard due to lack of API documentation
Bug #1599711 reported by
Thomi Richards
This bug affects 2 people
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Snapcraft |
Triaged
|
Medium
|
Unassigned | ||
Bug Description
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.
| Changed in snapcraft: | |
| status: | New → Confirmed |
Revision history for this message
| Leo Arias (elopio) wrote | #1 |
| Changed in snapcraft: | |
| importance: | Undecided → Medium |
| tags: | added: snap-docs |
| Changed in snapcraft: | |
| status: | Confirmed → Triaged |
Revision history for this message
| Kyle Fazzari (kyrofa) wrote | #2 |
To post a comment you must log in.
As a first step, we will be publishing a sphinx doc in a website for all the classes and methods of snapcraft. This is not a stable API yet, so next step is to clean the API and agree on what will be the stable and supported API, remove all the internals and nicely document the remaining public parts.