Changelog for future release

jdavid · jdavid · commit 2481c02cc01c · 2019-07-07T19:51:13.000+02:00
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,24 @@
+0.28.3 (UNRELEASED)
+-------------------------
+
+- Support for "/" operator to traverse trees
+  `#903 <https://github.com/libgit2/pygit2/pull/903>`_
+
+- New `Index.remove_all()`
+  `#920 <https://github.com/libgit2/pygit2/pull/920>`_
+
+- New `Repository.lookup_reference_dwim(..)` and `Repository.resolve_refish(..)`
+  `#922 <https://github.com/libgit2/pygit2/pull/922>`_
+
+- Fix spurious exception in config
+  `#916 <https://github.com/libgit2/pygit2/issues/916>`_
+  `#917 <https://github.com/libgit2/pygit2/pull/917>`_
+
+- Minor fixes
+  `#919 <https://github.com/libgit2/pygit2/pull/919>`_
+  `#921 <https://github.com/libgit2/pygit2/pull/921>`_
+
+
 0.28.2 (2019-05-26)
 -------------------------
 
diff --git a/docs/references.rst b/docs/references.rst
@@ -2,7 +2,14 @@
 References
 **********************************************************************
 
-.. py:attribute:: Repository.references
+.. autoclass:: pygit2.Repository
+   :members: lookup_reference, lookup_reference_dwim, resolve_refish
+   :noindex:
+
+   .. attribute:: Repository.references
+
+      Returns an instance of the References class (see below).
+
 
 .. autoclass:: pygit2.repository.References
    :members:
@@ -13,7 +20,7 @@ Example::
 
     >>> all_refs = list(repo.references)
 
-    >>> master_ref = repo.lookup_reference("refs/heads/master")
+    >>> master_ref = repo.references["refs/heads/master"]
     >>> commit = master_ref.peel() # or repo[master_ref.target]
 
     # Create a reference
@@ -64,7 +71,7 @@ The Reference type
 
    Example::
 
-      >>> branch = repository.lookup_reference("refs/heads/master")
+      >>> branch = repository.references["refs/heads/master"]
       >>> branch.target = another_commit.id
       >>> committer = Signature('Cecil Committer', 'cecil@committers.tld')
       >>> branch.log_append(another_commit.id, committer,
@@ -84,7 +91,7 @@ The HEAD
 
 Example. These two lines are equivalent::
 
-    >>> head = repo.lookup_reference('HEAD').resolve()
+    >>> head = repo.references['HEAD'].resolve()
     >>> head = repo.head
 
 .. autoattribute:: pygit2.Repository.head
