You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When using the "Live Docs" feature, the different methods for a function are not separated, and it's not always clear where the docs for one method starts and another begins.
The following example is created after importing DataFrames.jl in a blank notebook and looking up help for Base.ndims:
Method signatures are usually a good indicator of a docstring starting, but since the docstrings can also end with examples, it's not easy to visually search through the doc box to find the right method.
The issue is also visible in the cell renders, i.e. when you're defining multiple methods each with their own docs and the docs get collapsed together:
When using the "Live Docs" feature, the different methods for a function are not separated, and it's not always clear where the docs for one method starts and another begins.
The following example is created after importing DataFrames.jl in a blank notebook and looking up help for
Base.ndims
:Method signatures are usually a good indicator of a docstring starting, but since the docstrings can also end with examples, it's not easy to visually search through the doc box to find the right method.
In contrast, Documenter.jl uses a thin line to separate method docs, which make it (at least a little) easier. Image taken from https://dataframes.juliadata.org/stable/lib/functions/#Base.ndims:
The issue is also visible in the cell renders, i.e. when you're defining multiple methods each with their own docs and the docs get collapsed together:
MWE pdf file (relevant section is output of 2nd cell): Interesting analysis.pdf
MWE Pluto.jl notebook
The text was updated successfully, but these errors were encountered: