alarsyo/spot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

python: docstrings cleanup

Browse source 
* wrap/python/spot.py: Better docstrings.
* wrap/python/tests/formulas.ipynb: Update.
This commit is contained in:
Alexandre Duret-Lutz 2015-10-04 12:17:06 +02:00
parent 67468acb18
commit 1f0258e9f7
2 changed files with 53 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

12
wrap/python/tests/formulas.ipynb
View file

@ -246,12 +246,16 @@
"Help on function _formula_format in module spot:\n",
"\n",
"_formula_format(self, spec)\n",
" Format the formula according to spec.\n",
" Format the formula according to `spec`.\n",
" \n",
" 'spec' should be a list of letters that select\n",
" how the formula should be formatted.\n",
" Parameters\n",
" ----------\n",
" spec : str, optional\n",
" a list of letters that specify how the formula\n",
" should be formatted.\n",
" \n",
" Use one of the following letters to select the syntax:\n",
" Supported specifiers\n",
" --------------------\n",
" \n",
" - 'f': use Spot's syntax (default)\n",
" - '8': use Spot's syntax in UTF-8 mode\n",