interfaces: add summary to each interface #3396

Merged
merged 3 commits into from May 24, 2017

Conversation

Projects
None yet
3 participants
Contributor

zyga commented May 24, 2017

This branch adds summary to all 91 interfaces currently known by snapd. The
actual text is expected to change and is an invitation to suggestions and
re-wordings.

zyga added some commits May 23, 2017

interfaces: expand MetaData to include Summary and DocumentationURL
Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
interfaces: add summary and docs URL to common interface
Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
interfaces: add summary to each interface
Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

As I said on IRC, I don't like the "allows gerunding" (or "allows access to") at the start of most of these; in all cases I think things would be better (clearer, cleaner, and sharper) by just making it start with the verb.

This can easily be done in a follow up, and I don't want to block this feature with this, but ... :-)

@zyga zyga merged commit 5980b28 into snapcore:master May 24, 2017

6 of 7 checks passed

xenial-i386 autopkgtest finished (failure)
Details
artful-amd64 autopkgtest finished (success)
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
xenial-amd64 autopkgtest finished (success)
Details
xenial-ppc64el autopkgtest finished (success)
Details
yakkety-amd64 autopkgtest finished (success)
Details
zesty-amd64 autopkgtest finished (success)
Details

@zyga zyga deleted the zyga:feature/iface-summary-brainstorm branch May 24, 2017

Contributor

zyga commented May 24, 2017

Merged and about to prepare another branch with reworked wording.

This is great, is this working towards the goal of exposing these on install?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment