Doc tweaks (#75)

* some doc tweaks

* change github pr/issue link prefix

README.rst

@@ -77,7 +77,7 @@ by Jake VanderPlas.
                       'init': Glider})
 
 3. Create an input ``xarray.Dataset``, run the model and get an output
-   ``Dataset``:
+   ``xarray.Dataset``:
 
 .. code-block:: python
 

doc/conf.py

@@ -64,8 +64,8 @@
 ]
 
 extlinks = {
-    'issue': ('https://github.com/benbovy/xarray-simlab/issues/%s', 'GH'),
-    'pull': ('https://github.com/benbovy/xarray-simlab/pull/%s', 'PR')
+    'issue': ('https://github.com/benbovy/xarray-simlab/issues/%s', '#'),
+    'pull': ('https://github.com/benbovy/xarray-simlab/pull/%s', '#')
 }
 
 autosummary_generate = True

xsimlab/process.py

@@ -470,10 +470,10 @@ def process(maybe_cls=None, autodoc=False):
 
     A process class usually implements:
 
-    - An interface as a set of variables defined as class attributes
-      (see :func:`variable`, :func:`on_demand`, :func:`foreign` and
-      :func:`group`). This decorator automatically adds properties to
-      get/set values for these variables.
+    - An interface as a set of variables defined as class attributes (see
+      :func:`variable`, :func:`on_demand`, :func:`foreign` and :func:`group`).
+      When the class is used within a :class:`Model` object, this decorator
+      automatically adds properties to get/set values for these variables.
 
     - One or more methods among ``initialize()``, ``run_step()``,
       ``finalize_step()`` and ``finalize()``, which are called at different