Documentation of bzrlib is sparse

Bug #1073129 reported by Alexander Gabriel
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Bazaar
Confirmed
Low
Unassigned

Bug Description

a few examples:
- sparse information on key aspects:
    tutorials/howtos/examples on basic use cases (creating a standalone branch for example)

- no information on the format of paramters (dict, set, plain)
    example: from_paths in bzrlib.workingtree.WorkingTree.move() is this a set?

- no information on details of parameters
    example: The paths in bzrlib.workingtree.WorkingTree.rename_one() are relative to what?

- no information on the expected classes/subclasses
    example: what is "target" (Branch, URL,?) in bzrlib.branch.Branch.push()?

bzrlib is huge, knowing what parts you need and how to combine them is far from obvious.

This makes working with bzrlib a pain while working with bzr was a breeze.

Vincent Ladeuil (vila)
Changed in bzr:
status: New → Confirmed
importance: Undecided → Low
Jelmer Vernooij (jelmer)
tags: added: check-for-breezy
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.