Commit f7ca0d65 authored by Grant Paton-Simpson's avatar Grant Paton-Simpson

Align notebook to other changes; bump version

parent e07c94e8
Pipeline #585 failed with stages
0# https://git.nzoss.org.nz/pyGrant/superhelp
version number: 0.9.22
version number: 0.9.23
author: Grant Paton-Simpson
## Overview
......
......@@ -35,8 +35,10 @@
"\n",
"### Within Python scripts\n",
"\n",
" from superhelp.helper import superhelp as shelp\n",
" shelp(snippet=\"myVar = 'Eggs'\")\n"
"The easiest way is to add the following at the top of your script:\n",
"\n",
" import superhelp\n",
" superhelp.this()\n"
]
},
{
......@@ -56,11 +58,11 @@
"@register_line_cell_magic\n",
"def shelp(line, cell=None):\n",
" from functools import partial\n",
" from superhelp.helper import get_advice\n",
" get_advice = partial(get_advice,\n",
" file_path=None, displayer='html', message_level='Extra', in_notebook=True)\n",
" from superhelp.helper import get_help\n",
" get_help = partial(get_help,\n",
" file_path=None, output='html', detail_level='Extra', in_notebook=True)\n",
" snippet = (line or \"\") + (cell or \"\")\n",
" html = get_advice(snippet)\n",
" html = get_help(snippet)\n",
" display(HTML(html))\n",
"\n",
"del shelp ## In an interactive session, we need to delete these to avoid name conflicts for automagic to work on line magics."
......@@ -256,14 +258,14 @@
"<p><code>myVar</code> is a string.</p>\n",
"<p>Python makes it easy to do lots of cool things with strings.</p>\n",
"<p>For illustration, imagine we have string 'Eggs' assigned to <code>myVar</code>:</p>\n",
"<p>myVar.upper() returns EGGS.</p>\n",
"<p><code>myVar.upper()</code> returns EGGS.</p>\n",
"</div>\n",
"<div class='help help-Main'>\n",
"<h4>String Overview</h4>\n",
"<p><code>myVar</code> is a string.</p>\n",
"<p>Python makes it easy to do lots of cool things with strings.</p>\n",
"<p>For illustration, imagine we have string 'Eggs' assigned to <code>myVar</code>:</p>\n",
"<p>myVar.upper() returns EGGS.</p>\n",
"<p><code>myVar.upper()</code> returns EGGS.</p>\n",
"<p>Examples:</p>\n",
"<p><code>myVar.upper()</code> returns EGGS.</p>\n",
"<p><code>myVar.center(70, '=')</code> returns\n",
......@@ -599,7 +601,7 @@
"<p>Using the reversed function does not apply any sorting to the sequence\n",
"being reversed - it merely flips the (possibly) unordered sequence the\n",
"other way.</p>\n",
"<p>2) the list sort method e.g. <code>my_list.sort()</code> returns <code>None</code>, not the\n",
"<p>2) the list sort method e.g. <code>my_list.sort()</code> returns <code>None</code>, not the\n",
"sorted list</p>\n",
"<p><code>sorted(my_list)</code> returns a sorted list but <code>my_list.sort()</code> is an in-\n",
"place process. It mutates something rather than returning a separate\n",
......
......@@ -2,7 +2,7 @@ from setuptools import setup, find_packages # @UnresolvedImport
from codecs import open
from os import path
__version__ = '0.9.22'
__version__ = '0.9.23'
here = path.abspath(path.dirname(__file__))
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment