Is there some way to view the package documentation from the REPL? If I use the help mode I get the following for an example: julia> using TimeSeries [ Info: Precompiling TimeSeries [9e3dc215-6440-5c97-bce1-76c03772f85e] help?> TimeSeries search: TimeSeries AbstractTimeSeries No documentation…

[image] devel-chm: Is there some way to view the package documentation from the REPL? You can access docstrings with ? — while packages are encouraged to provide one for modules, they may not have got around to it. [image] devel-chm: Is there a way to generate a locally viewable copy of …

You can access docstrings with ? — while packages are encouraged to provide one for modules, they may not have got around to it. How does on document a module with docstrings? I found documentation for functions, methods, types,… but nothing for modules. I’ve been using juliahub to find the on…

Docstrings can be for modules too. It’s actually a really useful feature that more packages should have. Thanks to @tim.holy , VideoIO now has one with a few pointers. https://github.com/JuliaIO/VideoIO.jl/blob/fadad30fb24bd18bf78d22c3ce578af5806f1c96/src/VideoIO.jl#L162 i.e. ? VideoIO

100% agree. That looks like a very good example as well.

Every now and again we discuss having default docstrings for the main module of packages such that if they do not have explict docstrings thern the README.md is shown.

I saw this trick for including the REAMDE as a docstring in @tkf ’s packages: [image] Plea to package developers regarding documentation! Community I usually put a badge like this [GitHub commits since tagged version] in README with [![GitHub commits since tagged version]…

[image] oxinabox: Every now and again we discuss having default docstrings for the main module of packages such that if they do not have explict docstrings thern the README.md is shown. I PR’ed the basic idea https://github.com/JuliaLang/julia/pull/39093

Access package documentation in REPL

General Usage

Tamas_Papp December 7, 2020, 8:09am 7

I saw this trick for including the REAMDE as a docstring in @tkf’s packages:

Topic		Replies	Views
REPL help mode discoverability General Usage suggestions	11	2454	December 15, 2020
Easy way to reach online documentation? General Usage documentation	10	880	July 1, 2022
Documentation needs to be more discoverable and explorable General Usage documentation	24	1790	November 24, 2023
Comprehensive Package Info Package Management package	6	689	March 27, 2021
No documentation for Base packages at REPL help prompt General Usage documentation	2	1059	April 18, 2017

Access package documentation in REPL

Related topics