Tweak docs

tkf · Aug 31, 2018 · 23ad274 · 23ad274
1 parent eaf26a9
commit 23ad274
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -26,7 +26,7 @@ Features
 
 * `Julia's Multimedia I/O`_ hooked into `IPython's display system`_
 * Code completion inside Julia magic (by **monkey-patching** IPython)
-* Copy-free access to Julia objects from IPython
+* Copy-free access to Julia objects from Python
 
 Those are build on top of the great libraries PyCall.jl_ and PyJulia_.
 (It would be nice to merge some features to PyJulia_ at some point.

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -15,8 +15,17 @@ API
    :members:
 
 
+Demos
+=====
+
+* Using Plots.jl etc. inside IPython Jupyter kernel: `Notebook <nb-plots.jl>`_
+
+.. _nb-plots.jl:
+   https://nbviewer.jupyter.org/gist/tkf/f46826bb21ea1377562428beed00a799
+
+
 Using ForwardDiff from Python
-=============================
+-----------------------------
 
 >>> from ipyjulia_hacks import get_main, jlfunction
 >>> @jlfunction

diff --git a/src/ipyjulia_hacks/__init__.py b/src/ipyjulia_hacks/__init__.py
@@ -27,7 +27,7 @@
 
 * `Julia's Multimedia I/O`_ hooked into `IPython's display system`_
 * Code completion inside Julia magic (by **monkey-patching** IPython)
-* Copy-free access to Julia objects from IPython
+* Copy-free access to Julia objects from Python
 
 Those are build on top of the great libraries PyCall.jl_ and PyJulia_.
 (It would be nice to merge some features to PyJulia_ at some point.

diff --git a/src/ipyjulia_hacks/core/julia_api.py b/src/ipyjulia_hacks/core/julia_api.py
@@ -137,7 +137,7 @@ def maybe_unwrap(self, obj):
 
     def getattr(self, obj, name):
         """
-        Get attribute (property) named `name` of Julia object `obj`.
+        Get attribute (property) named `name` of a Julia object `obj`.
         """
         try:
             return self.maybe_wrap(self.getproperty(obj, jl_name(name)))