Skip to content

Commit

Permalink
Include NEWS file in documentation
Browse files Browse the repository at this point in the history
The file was reformatted to fully work with sphinx' ReST.
  • Loading branch information
chrysn committed Dec 9, 2016
1 parent c51ac67 commit cf01c65
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 19 deletions.
38 changes: 19 additions & 19 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
Version 0.3
===========
-----------

Features
--------
~~~~~~~~

* 4d07615: ICMP errors are handled
* 1b61a29: Accept 'fe80::...%eth0' style addresses
* 3c0120a: Observations provide modern `async for` interface
* 3c0120a: Observations provide modern ``async for`` interface
* 4e4ff7c: New demo: file server
* ef2e45e, 991098b, 684ccdd: Messages can be constructed with options,
modified copies can be created with the .copy method, and default codes are
provided
* 08845f2: Request objects have .response_nonraising and .response_raising
interfaces for easier error handling
modified copies can be created with the ``.copy`` method, and default codes
are provided
* 08845f2: Request objects have ``.response_nonraising`` and
``.response_raising`` interfaces for easier error handling
* ab5b88a, c49b5c8: Sites can be nested by adding them to an existing site,
catch-all resources can be created by subclasing PathCapable
catch-all resources can be created by subclassing PathCapable

Possibly breaking changes
-------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~

* ab5b88a: Site nesting means that server resources do not get their original
Uri-Path any more
Uri-Path any more
* bc76a7c: Location-{Path,Query} were opaque (bytes) objects instead of
strings; disctinction between accidental and intentional opaque options is
now clarified
strings; disctinction between accidental and intentional opaque options is
now clarified

Small features
--------------
~~~~~~~~~~~~~~

* 2bb645e: set_request_uri allows URI parsing without sending Uri-Host
* e6b4839: Take block1.size_exponent as a sizing hint when sending block1 data
Expand All @@ -38,15 +38,15 @@ Small features
* fabcfd5: .well-known/core supports filtering

Internals
---------
~~~~~~~~~

* f968d3a All low-level networking is now done in aiocoap.transports; it's not
really hotpluggable yet and only UDPv6 (with implicit v4 support) is
implemented, but an extension point for alternative transports.
* bde8c42 recvmsg is used instead of recvfrom, requiring some asyncio hacks
* f968d3a: All low-level networking is now done in aiocoap.transports; it's not
really hotpluggable yet and only UDPv6 (with implicit v4 support) is
implemented, but an extension point for alternative transports.
* bde8c42: recvmsg is used instead of recvfrom, requiring some asyncio hacks

Package management
------------------
~~~~~~~~~~~~~~~~~~

* 01f7232, 0a9d03c: aiocoap-client and -proxy are entry points
* 0e4389c: Establish an extra requirement for LinkHeader
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@

examples
tools
news
LICENSE
8 changes: 8 additions & 0 deletions doc/news.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Change log
==========

This summarizes the changes between released versions. For a complete change
log, see the git history. For details on the changes, see the respective git
commits indicated at the start of the entry.

.. include:: ../NEWS

0 comments on commit cf01c65

Please sign in to comment.