search

microsoft / jupyter-core

Library for writing Jupyter kernels in .NET Core
MIT License
108 stars 23 forks source link

Add documentation fields to magic command HTML encoding #58

Closed rmshaffer closed 4 years ago

rmshaffer commented 4 years ago

Magic commands have a detailed Documentation struct thanks to @cgranade's work, but only the Summary property is printed when running a help command such as %magic?.

This PR adds the remaining documentation fields (Description, Remarks, and Examples) to the HTML encoding, if they exist.

Here's an example of how it looks, using the %config magic from IQ# as an example:

image