Merge lp:~gustav-hartvigsson/brz/fix-integration-docs into lp:brz

[Gustav Hartvigsson]

Mention the need to load bzr or git modules in the docs.

Request for Comments

Fixed bug #1910860.

[Jelmer Vernooij (jelmer)]

review: Approve

=== modified file 'doc/developers/integration.txt'
--- doc/developers/integration.txt	2020-12-11 15:47:15 +0000
+++ doc/developers/integration.txt	2021-01-11 23:04:48 +0000
@@ -48,6 +48,18 @@
 This will send output through the current UIFactory; you can redirect this
 elsewhere through the parameters to `breezy.initialize`.
 
+Load the ``bzr`` and/or ``git`` module(s)
+=========================================
+The code below have the prerequisite that you have imported either of
+the ``bzr`` or ``git`` module, or both::
+
+  import breezy.bzr
+  import breezy.git
+
+Depending on what the code is intended to do, the corresponding module or
+modules need to be imported (``bzr`` for Bazaar, and ``git`` for git), or some
+of the code will not work, and will cause errors like
+``breezy.errors.NotBranchError``.
 
 Manipulating the Working Tree
 =============================