@@ -11,20 +11,29 @@ As a result, unless a bug is present only in the PHP version, pull requests
1111are unlikely to be accepted unless they are themselves direct transliterations
1212of bugfixes in the Python version.
1313
14- New in version 0.7.0:
15-
16- - API has changed slightly. ``Docopt\docopt `` has been renamed to ``Docopt::handle ``
17- to fix autoloader support. See issue #3.
14+ **This port has been marked version 1.0.0 RC1 **. It is based on the Python version at
15+ commit `1937a1c9041e0f580d2890d38bb71c0a0623847f
16+ <https://github.com/docopt/docopt/commit/d5b96f878abbda51b62f1e28010d2b42b19a27dc> `_
17+ (labelled **0.6.1 **).
18+
19+ It has been quite stable for a long time and has barely been changed. The Python version
20+ receives only occasional bugfixes and keeping the version numbers pinned has been more
21+ trouble than it has been worth.
22+
23+ There are also some major backward compatibility breaks. Rather than dwell in 0.x semver
24+ hell, the PHP port will liberally bump major numbers henceforth when BC breaks regardless
25+ of the reason.
1826
19- - Compatibility with Python master branch at commit `d5b96f878a
20- <https://github.com/docopt/docopt/commit/d5b96f878abbda51b62f1e28010d2b42b19a27dc> `_
27+ - The PHP API has changed slightly. ``Docopt\docopt `` has been renamed to
28+ ``Docopt::handle `` to fix autoloader support. See issue #3.
29+
30+ - Docopt.py also has a significant BC break. Existing users should read the information
31+ below about Usage and Option sections. See `issue 102
32+ <https://github.com/docopt/docopt/issues/102> `_ for more info.
2133
22- - Significant BC break. Existing users should read the information below about Usage and
23- Option sections. See `issue 102 <https://github.com/docopt/docopt/issues/102 >`_ for more
24- info.
2534
2635Please see the `Python version's README <https://github.com/docopt/docopt/blob/master/README.rst >`_
27- for any new and breaking changes that are not specific to the PHP version.
36+ for details of any new and breaking changes that are not specific to the PHP version.
2837
2938-----
3039
@@ -102,6 +111,21 @@ self-contained. `Get source on github <http://github.com/docopt/docopt.php>`_.
102111``docopt.php `` is tested with PHP 5.4 and PHP 5.3.
103112
104113
114+ Testing
115+ ======================================================================
116+
117+ Configure your repo for running tests::
118+
119+ ./dev-setup
120+
121+ You can run unit tests with the following command::
122+
123+ php test.php
124+
125+ This will run the Python language agnostic tests as well as the PHP
126+ docopt tests.
127+
128+
105129API
106130======================================================================
107131
@@ -306,10 +330,10 @@ Use the following constructs to specify patterns:
306330- **[options] ** (case sensitive) shortcut for any options. You can
307331 use it if you want to specify that the usage pattern could be
308332 provided with any options defined below in the option-descriptions
309- and do not want to enumerate them all in usage-pattern. -
333+ and do not want to enumerate them all in usage-pattern.
310334 "``[--] ``". Double dash "``-- ``" is used by convention to separate
311335 positional arguments that can be mistaken for options. In order to
312- support this convention add "``[--] ``" to you usage patterns. -
336+ support this convention add "``[--] ``" to you usage patterns.
313337 "``[-] ``". Single dash "``- ``" is used by convention to signify that
314338 ``stdin `` is used instead of a file. To support this add "``[-] ``"
315339 to you usage patterns. "``- ``" act as a normal command.
@@ -349,7 +373,7 @@ It is necessary to list option descriptions in order to specify:
349373The rules are as follows:
350374
351375- Every line in the options section body that starts with one or more
352- horizontal whitespace characters, followed by ``- `` or ``--``is treated
376+ horizontal whitespace characters, followed by ``- `` or ``-- `` is treated
353377 as an option description, e.g.::
354378
355379 Options:
0 commit comments