api: Connection interface not well documented

Bug #1581612 reported by Roger Peppe
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Canonical Juju
Fix Released
Medium
Unassigned

Bug Description

Several of the methods in the api.Connection have only cursory
doc comments (for the record: http://paste.ubuntu.com/16392503/).
The correct doc comments are on the unexported api.state type and
should probably be moved to the api.Connection methods.

This is important because the Connection is *the* externally
visible API for anyone that's writing a Go client that uses juju.

Tags: api helptext docs
Changed in juju-core:
status: New → Triaged
importance: Undecided → Medium
tags: added: api docs
Changed in juju-core:
milestone: none → 2.0.0
affects: juju-core → juju
Changed in juju:
milestone: 2.0.0 → none
milestone: none → 2.0.0
Curtis Hovey (sinzui)
Changed in juju:
milestone: 2.0.0 → 2.0.1
Curtis Hovey (sinzui)
Changed in juju:
milestone: 2.0.1 → none
tags: added: helptext
Revision history for this message
Tim McNamara (tim-clicks) wrote :

Closing as the help text has been updated with time. Although no way near perfect, we can open another bug report if required. https://paste.ubuntu.com/p/rBCyWyPTz6/

Changed in juju:
status: Triaged → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.