Export title and description as module docstring

[aar0n]

I see that since 2.2 you can export a module docstring via __doc__:

New features since v2.2

Here’s a quick summary of some of the interesting new features added in the v2.2 series. For details, see the changelog. Pre-commit hooks: If you use classic Jupyter, or Lab, then the Jupyter+git problem is now solved. However for vscode and other 3rd party Jupyter clients notebook conflicts are still a problem. However if you use the new pre-commit hook support, you can largely avoid this problem by having your notebooks cleaned when you commit to git. Module level docstrings: If you assign a…

Also, the _md2dict function in the frontmatter module extracts a title and description from an h1 formatted markdown cell.

What does everyone think about having an option to export this title and description into the module docstring as an alternative to setting __doc__?

Some reasons why this might be good:

• Having a __doc__ = in your notebook is a bit ugly and does not allow nice rendering.
• If we have a #h1 and > description, then having a __doc__ as well might lead to duplicate content

One issue is that (AFAICT) the _md2dict function only extracts a single line as a description. In order to have multiline docstrings, this would need to be edited to allow multiline descriptions. So for example,:

# module title

> some description
> more description

the above would become the module level docstring (perhaps via some directive if appropriate).

Would be interested to hear the community’s thoughts. If there is interest and agreement I’d be happy to write a pull request.

[jeremy (Jeremy Howard)]

Sounds like a great idea to me!