Many people find using the command line a bit daunting and Jupyter notebooks unfamiliar so here is another way of using SuperHELP that may be much easier.
- Put the following at the top of your script:
- Run the script
- See the advice
- Learn something; make changes 🙂
If you don’t want the default web output you can specify other output such as ‘cli’ (command line interface) or ‘md’ (markdown):
import superhelp superhelp.this(output='md')
If you don’t want the default ‘Extra’ level of detail you can specify a different detail_level (‘Brief’ or ‘Main’) e.g.
import superhelp superhelp.this(output='md', detail_level='Brief')
import superhelp superhelp.this(detail_level='Main')
Edited to remove reference to explicit file_path argument e.g. superhelp.this(__file__). It is not needed anymore thanks to the Python inspect library. Also displayer -> output and message_level -> detail_level.