Update the documentation

docs/CHANGELOG.rst

@@ -1,102 +1,106 @@
-.. :changelog:
+.. _changelog:
 
-==========
 Change log
 ==========
 
 All notable changes to this project will be documented in this file.
-The format is based on `Keep a Changelog`_ and this project adheres to `Semantic Versioning`_.
+The format is based on `Keep a Changelog`_ and this project adheres to
+`Semantic Versioning`_.
 
 Unreleased
-==========
+----------
 Added
------
+*****
 * Work with sandbox and real account
 
 Changed
--------
+*******
 * Changed the API for FnapyConnection
-* Set a list of eans as an argument in query_pricing
+* ``query_pricing`` now accepts a list of EANs
 
 [0.6.0] - 2016-10-07
-====================
-Changed
--------
-* Improved Query class
+--------------------
+Added
+*******
+* In the ``Query`` class, added the ``was`` method to handle the states (especially
+  the states of orders)
 
 [0.5.1] - 2016-10-04
-====================
+--------------------
 Removed
--------
-* Really remove BeautifulSoup (bs4) from dependencies
+*******
+* Really remove ``BeautifulSoup`` (bs4) from the dependencies
 
 [0.5.0] - 2016-10-04
-====================
+--------------------
 Removed
--------
-* Remove beautifulsoup dependency
+*******
+* Remove ``BeautifulSoup`` dependency
 
 Changed
--------
-* Improve text extraction from XML
+*******
+* Improve the text extraction from XML
 
 [0.4.3] - 2016-09-29
-====================
+--------------------
 Changed
--------
-* Raise a FnapyPricingError if offers_data is not empty (in update_offers)
+*******
+* In ``update_offers``, ``FnapyUpdateOfferError`` is raised if: 
+    - ``offer_reference`` and at least one of the optional parameters (except
+      ``product_reference``) are not provided
+    - ``offers_data`` is empty
 
 [0.4.2] - 2016-09-28
-====================
+--------------------
 Changed
--------
+*******
 * Update documentation
 
 [0.4.1] - 2016-09-28
-====================
+--------------------
 Added
------
-* Implement delete_offers
+*****
+* Implement ``delete_offers``
 
 [0.4.0] - 2016-09-27
-====================
+--------------------
 Changed
--------
+*******
 * Use pricing_query (V2)
-* Check the connection passed to FnapyManager is a FnapyConnection
+* Check the connection passed to ``FnapyManager`` is a ``FnapyConnection``
 * Add a caveat in the README for the requests sent to the sandbox.
-* Improve update_offers
+* Improve ``update_offers``
 
 Fixed
------
-* Fix Unicode/string confusion bug in Response
+*****
+* Fix Unicode/string confusion bug in ``Response``
 
 [0.2.0] - 2016-09-13
-====================
-
+--------------------
 Added
------
+*****
 * Support Python 3
-* Implement Query class to allow complex queries
+* Implement the ``Query`` class to allow complex queries
+* Added new classes for requests and responses 
+  (respectively ``Request`` and ``Response``)
 
 Changed
--------
+*******
 * Update the documentation
 * Make the manager authenticate when it is created.
-* All the methods return a Response instance
-* Store the XML requests as Request instances
+* All the methods return a ``Response`` instance
+* Store the XML requests as ``Request`` instances
 
 Fixed
------
+*****
 * Fixed the packaging
-* Test the Request and Response classes
-* Fix minor things in the constructor of FnapyManager
+* Fix minor things in the constructor of ``FnapyManager``
 
 [0.1.0] - 2016-08-31
-====================
+--------------------
 Added
------
-* Create the fnapy package
+*****
+* Create the ``fnapy`` package
 
 .. _Keep a changelog: http://keepachangelog.com/ 
 .. _Semantic Versioning: http://semver.org/