Update Remotes section (#502)

forresthopkinsa · Byron · commit df65f51de6ba · 2016-08-24T07:45:52.000+02:00
Update Remotes section

The Remotes section was missing some pretty important info.
diff --git a/git/test/test_docs.py b/git/test/test_docs.py
@@ -373,8 +373,13 @@ def test_references_and_objects(self, rw_dir):
         assert origin == empty_repo.remotes.origin == empty_repo.remotes['origin']
         origin.fetch()                  # assure we actually have data. fetch() returns useful information
         # Setup a local tracking branch of a remote branch
-        empty_repo.create_head('master', origin.refs.master).set_tracking_branch(origin.refs.master)
-        origin.rename('new_origin')   # rename remotes
+        empty_repo.create_head('master', origin.refs.master)  # create local branch "master" from remote branch "master"
+        empty_repo.heads.master.set_tracking_branch(origin.refs.master)  # set local "master" to track remote "master
+        empty_repo.heads.master.checkout()  # checkout local "master" to working tree
+        # Three above commands in one:
+        empty_repo.create_head('master', origin.refs.master).set_tracking_branch(origin.refs.master).checkout()
+        # rename remotes
+        origin.rename('new_origin')
         # push and pull behaves similarly to `git push|pull`
         origin.pull()
         origin.push()
