Skip to content

Commit f86a06d

Browse files
committed
tim comments in specification doc
1 parent 1c66925 commit f86a06d

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

docs/source/specification.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,20 @@ and the resulting actions that repo2docker takes is known
1010
as the **Reproducible Execution Environment Specification** (or REES).
1111

1212
The goal of the REES is to automate and encourage existing community best practices
13-
for reproducible computational environments. This includes installing
14-
community-standard specification files such as ``requirements.txt`` or ``REQUIRE`` using
15-
standard tools such as ``pip`` or ``conda`` or ``apt``. While repo2docker automates the
13+
for reproducible computational environments. This includes installing pacakges using
14+
community-standard specification files and their corresponding tools,
15+
such as ``requirements.txt`` (with ``pip``), ``REQUIRE`` (with Julia), or
16+
``apt.txt`` (with ``apt``). While repo2docker automates the
1617
creation of the environment, a human should be able to look at a REES-compliant
1718
repository and reproduce the environment using common, clear steps without
1819
repo2docker software.
1920

2021
Currently, the definition of the REE Specification is the following:
2122

22-
Any collection of files taken from the :ref:`config-files`
23-
list, placed either in the root of a folder or in a sub-folder called
24-
either ``binder/`` or ``.binder/``.
23+
Any directory containing zero or more files from the :ref:`config-files` list is a
24+
valid reproducible execution environment as defined by the REES. The
25+
configuration files have to all be placed either in the root of the
26+
directory, in a ``binder/`` sub-directory or a ``.binder/`` sub-directory.
2527

2628
For example, the REES recognises ``requirements.txt`` as a valid config file.
2729
The file format is as defined by the ``requirements.txt`` standard of the Python

docs/source/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Using ``repo2docker``
1111
``repo2docker``, see :ref:`install`.
1212

1313
``repo2docker`` can build a reproducible computational environment for any repository that
14-
follows :ref:`specification`. repo2docker is called with a URL/path to a git repository. It then
14+
follows :ref:`specification`. repo2docker is called with a URL/path to a repository. It then
1515
performs these steps:
1616

1717
1. Inspects the repository for :ref:`configuration files <config-files>`. These will be used to build

0 commit comments

Comments
 (0)