From 5547f62176876ee62b0c44b8d481d9442c839a41 Mon Sep 17 00:00:00 2001 From: Ferdinand Majerech Date: Sat, 15 Oct 2011 18:28:34 +0200 Subject: [PATCH] Final changes for the 0.2 release (hopefully). --- CHANGES.txt | 19 +++++++++++++++++ README.html | 26 ++++++++---------------- README.rst | 23 +++++++++------------ doc/doctrees/environment.pickle | Bin 12705 -> 12705 bytes doc/html/.buildinfo | 2 +- doc/html/articles/spec_differences.html | 10 ++++----- doc/html/index.html | 10 ++++----- doc/html/objects.inv | Bin 202 -> 202 bytes doc/html/search.html | 10 ++++----- doc/html/tutorials/custom_types.html | 10 ++++----- doc/html/tutorials/getting_started.html | 10 ++++----- doc/html/tutorials/yaml_syntax.html | 10 ++++----- docsrc/conf.py | 4 ++-- 13 files changed, 71 insertions(+), 63 deletions(-) create mode 100644 CHANGES.txt diff --git a/CHANGES.txt b/CHANGES.txt new file mode 100644 index 0000000..048bd9f --- /dev/null +++ b/CHANGES.txt @@ -0,0 +1,19 @@ +0.2.0: + + +- FEATURES/IMPROVEMENTS: + + - Implemented YAML emitter, and related unittests/documentation. + + - Tags are now stored in nodes, allowing D:YAML to be closer to the + specification. + + - Loader API has been broken to make it more extensible in future - + Representer and Constructor are no more specified in the constructor, + and the load() shortcut functions have been removed, as all that's needed to + load a YAML document now is Loader("file.yaml").load() . + + +- BUGFIXES: + + - Fixed many bugs in the parser, scanner, composer and constructor. diff --git a/README.html b/README.html index 255bb10..5c0d14a 100644 --- a/README.html +++ b/README.html @@ -4,7 +4,7 @@ -D:YAML 0.1 +D:YAML 0.2 -
-

D:YAML 0.1

+
+

D:YAML 0.2

Introduction

-

D:YAML is an open source YAML parser library for the D programming language. -It is +

D:YAML is an open source YAML parser and emitter library for the D programming +language. It is (almost) compliant to the YAML 1.1 specification. Much of D:YAML code is based on PyYAML created by Kirill Simonov. D:YAML has no external dependencies, all it needs is a D compiler and Phobos (standard library). It is written in D2 and there are no plans for D1 or Tango support.

-

At the moment, D:YAML can only read, not write YAML files. This will change in -the following releases. D:YAML is designed to be as easy to use as possible while -supporting the full feature set of YAML. To start using it in your project, -see the +

D:YAML is designed to be as easy to use as possible while supporting the full +feature set of YAML. To start using it in your project, see the Getting Started tutorial.

D:YAML is still a work in progress. Its API is still not stable and there might @@ -341,7 +339,7 @@ to be rewritten in future and D:YAML will change accordingly.

  • No external dependencies.
  • Supports all YAML 1.1 constructs. All examples from the YAML 1.1 specification are parsed correctly.
    • -
  • Read from YAML files as well as from memory or user defined streams.
    • +
  • Read and write from/to YAML files as well as memory or user defined streams.
  • UTF-8, UTF-16 and UTF-32 encodings are supported, both big and little endian (plain ASCII also works as it is a subset of UTF-8).
  • Support for both block (Python-like, based on indentation) and flow @@ -349,11 +347,10 @@ are parsed correctly.
  • Support for YAML anchors and aliases.
  • Support for default values in mappings.
  • Support for custom tags (data types), and implicit tag resolution for custom -tags.
    • +scalar tags.
  • All tags (data types) described at http://yaml.org/type/ are supported, with the exception of tag:yaml.org,2002:yaml, which is used to represent YAML code in YAML.
    • -
  • Cannot write YAML at the moment. This will change in the future.
  • There is no support for recursive data structures. There are no plans to implement this at the moment.
    • @@ -445,11 +442,6 @@ DEALINGS IN THE SOFTWARE.

    D:YAML was created using Vim and DMD on Debian and Ubuntu Linux as a YAML parsing library for the D programming language.

    -
    -
    -
    -Generated on: 2011-08-16 20:07 UTC. -
    diff --git a/README.rst b/README.rst index f63a7f8..9a14336 100644 --- a/README.rst +++ b/README.rst @@ -1,23 +1,21 @@ ========== -D:YAML 0.1 +D:YAML 0.2 ========== ------------ Introduction ------------ -D:YAML is an open source YAML parser library for the D programming language. -It is +D:YAML is an open source YAML parser and emitter library for the D programming +language. It is (`almost `_) compliant to the YAML 1.1 specification. Much of D:YAML code is based on `PyYAML `_ created by Kirill Simonov. D:YAML has no external dependencies, all it needs is a D compiler and Phobos (standard library). It is written in D2 and there are no plans for D1 or Tango support. -At the moment, D:YAML can only read, not write YAML files. This will change in -the following releases. D:YAML is designed to be as easy to use as possible while -supporting the full feature set of YAML. To start using it in your project, -see the +D:YAML is designed to be as easy to use as possible while supporting the full +feature set of YAML. To start using it in your project, see the `Getting Started `_ tutorial. @@ -36,7 +34,7 @@ Features * No external dependencies. * Supports all YAML 1.1 constructs. All examples from the YAML 1.1 specification are parsed correctly. -* Read from YAML files as well as from memory or user defined streams. +* Read and write from/to YAML files as well as memory or user defined streams. * UTF-8, UTF-16 and UTF-32 encodings are supported, both big and little endian (plain ASCII also works as it is a subset of UTF-8). * Support for both block (Python-like, based on indentation) and flow @@ -44,11 +42,10 @@ Features * Support for YAML anchors and aliases. * Support for default values in mappings. * Support for custom tags (data types), and implicit tag resolution for custom - tags. + scalar tags. * All tags (data types) described at http://yaml.org/type/ are supported, with the exception of ``tag:yaml.org,2002:yaml``, which is used to represent YAML code in YAML. -* Cannot write YAML at the moment. This will change in the future. * There is no support for recursive data structures. There are no plans to implement this at the moment. @@ -57,16 +54,16 @@ Features Directory structure ------------------- -=============== ====================================================================== +=============== ======================================================================= Directory Contents -=============== ====================================================================== +=============== ======================================================================= ``./`` This README file, utility scripts, D:YAML sources outside any packages. ``./doc`` Documentation. ``./docsrc`` Documentation sources. ``./dyaml`` D:YAML source code. ``./examples/`` Example D:YAML code. ``./test`` Unittest code and inputs. -=============== ====================================================================== +=============== ======================================================================= ----------------------- diff --git a/doc/doctrees/environment.pickle b/doc/doctrees/environment.pickle index e329ca1ba75be7eda37af0a04c2b9c33504ce951..b0bf0109b44443d19c3c0f979e740ee2f2eae1b0 100644 GIT binary patch delta 69 zcmZ3OyfAq~I0vKA<_Hcwb;F$By;j#Ul-(UKFU$Gea-Atd2g2;~T9;u8VRp#O&ai_p NTaWZ_-md?O5db5nAY=dl delta 69 zcmZ3OyfAq~I0vKQ<_Hcwb;Hz_a|d2zD7!meUY6Q&Z1J%S9SHOEgYFDd2=n9t&I~&U O^LWF$&D-@~F#-TT6d=3+ diff --git a/doc/html/.buildinfo b/doc/html/.buildinfo index ff4d13d..6366e2a 100644 --- a/doc/html/.buildinfo +++ b/doc/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: bc848a1b422611af46aa082001644165 +config: 3b89228da749be7cd7bc0e0980432c5f tags: fbb0d17656682115ca4d033fb2f83ba1 diff --git a/doc/html/articles/spec_differences.html b/doc/html/articles/spec_differences.html index cff7ce6..e0b8e1f 100644 --- a/doc/html/articles/spec_differences.html +++ b/doc/html/articles/spec_differences.html @@ -7,13 +7,13 @@ - Differences between D:YAML and the YAML specification — D:YAML v0.1 documentation + Differences between D:YAML and the YAML specification — D:YAML v0.2 documentation - + @@ -32,7 +32,7 @@
  • previous
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • @@ -133,7 +133,7 @@ struct appears in Phobos.

  • previous
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • diff --git a/doc/html/index.html b/doc/html/index.html index 5ab4bc5..4e17f43 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -7,13 +7,13 @@ - Welcome to D:YAML documentation! — D:YAML v0.1 documentation + Welcome to D:YAML documentation! — D:YAML v0.2 documentation - + @@ -32,7 +32,7 @@
  • next
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • @@ -99,7 +99,7 @@
  • next
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • diff --git a/doc/html/objects.inv b/doc/html/objects.inv index 5b82b6e34cfe40f4bd23b7a7bb97dd56c948711e..0985ffdc6e9a9463849a6fa9129054128d7c646a 100644 GIT binary patch delta 11 ScmX@bc#3g?4WrRS+g<<|!~^jF delta 11 ScmX@bc#3g?4Wr>i+g<<|zyt6A diff --git a/doc/html/search.html b/doc/html/search.html index 06a731d..af67bf2 100644 --- a/doc/html/search.html +++ b/doc/html/search.html @@ -7,13 +7,13 @@ - Search — D:YAML v0.1 documentation + Search — D:YAML v0.2 documentation - + @@ -34,7 +34,7 @@

    Navigation

    @@ -82,7 +82,7 @@

    Navigation

    diff --git a/doc/html/tutorials/custom_types.html b/doc/html/tutorials/custom_types.html index a8a86ea..2c51903 100644 --- a/doc/html/tutorials/custom_types.html +++ b/doc/html/tutorials/custom_types.html @@ -7,13 +7,13 @@ - Custom YAML data types — D:YAML v0.1 documentation + Custom YAML data types — D:YAML v0.2 documentation - + @@ -36,7 +36,7 @@
  • previous |
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • @@ -375,7 +375,7 @@ directory of the D:YAML package.

  • previous |
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • diff --git a/doc/html/tutorials/getting_started.html b/doc/html/tutorials/getting_started.html index ea39080..77c5422 100644 --- a/doc/html/tutorials/getting_started.html +++ b/doc/html/tutorials/getting_started.html @@ -7,13 +7,13 @@ - Getting started — D:YAML v0.1 documentation + Getting started — D:YAML v0.2 documentation - + @@ -36,7 +36,7 @@
  • previous |
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • @@ -232,7 +232,7 @@ example in the example/getting_st
  • previous |
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • diff --git a/doc/html/tutorials/yaml_syntax.html b/doc/html/tutorials/yaml_syntax.html index 71a9377..83da594 100644 --- a/doc/html/tutorials/yaml_syntax.html +++ b/doc/html/tutorials/yaml_syntax.html @@ -7,13 +7,13 @@ - YAML syntax — D:YAML v0.1 documentation + YAML syntax — D:YAML v0.2 documentation - + @@ -36,7 +36,7 @@
  • previous |
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • @@ -325,7 +325,7 @@ Some of these might change in the future (especially !!map and !!set).

  • previous |
    • -
  • D:YAML v0.1 documentation »
    • +
  • D:YAML v0.2 documentation »
    • diff --git a/docsrc/conf.py b/docsrc/conf.py index 30ac5d6..7cf85bc 100644 --- a/docsrc/conf.py +++ b/docsrc/conf.py @@ -49,9 +49,9 @@ copyright = (u'2011, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org ' # built documents. # # The short X.Y version. -version = '0.1' +version = '0.2' # The full version, including alpha/beta/rc tags. -release = '0.1' +release = '0.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.