Only build the fancy docstring when in an IPython context #774
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was a little surprised to see that Param was always building a docstring for IPython even not in an IPython context. This also came with some side-effects as the pager calls
.param.objects()
which leads to the Parameters being cached on the class:param/param/ipython.py
Line 63 in b96169f
This can only improve the performance of loading modules with lots of Parameterized classes that have lots of Parameters, no idea by how much though!
However, this of course also affects how the docstring look like in a non IPython context, e.g. in the Python REPL.
Before (colorized output):
With this change: