improve documentation (e.g. only_defs)

[TomLav]

Dear developer team. Thank you for importnb.

It was my first time using importnb this morning. Installation and first imports (incl. fuzzy finding) went fine, but I rapidly wanted to import only the functions and classes from a notebook.

The top-level documentation has a section "customizing parameters" that concludes with :

these features are defined in the importnb.loader.Interface class and they can be controlled throught the command line interface.

There is however no explanation how this can happen (neither how to use Interface() nor through the command line). Perusing the issues and PRs did not really help. I eventually found the answer in the code base:

import importnb

with importnb.Notebook(include_non_defs=False,):
    import Transformation__ as mynb

It would be great if the current documentation showed the correct name for the keyword (include_non_defs instead of only_defs). It would also be usefull if some common examples of how to use the importnb.Notebook() keywords were added to the doc.

I will be happy to contribute by commenting on documentation update, but do not feel I can create such a change given I know so little about the module and best practices.

[nazariyv]

helpful. thank you