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
A package to create simple "module docstrings" for Julia packages. These are targeted at summarizing the main components of your package, essentially as a prompt or reminder to users. For example:
9
+
10
+
```julia
11
+
julia>using ModuleDocstrings
12
+
13
+
help?> ModuleDocstrings
14
+
search: ModuleDocstrings
15
+
16
+
• ModuleDocstrings.generate: Create an API summary docstring for a
17
+
module.
18
+
19
+
• ModuleDocstrings.write: add an API summary docstring to a package.
20
+
```
21
+
22
+
Then, to learn more about `generate`:
23
+
24
+
```julia
25
+
help?> ModuleDocstrings.generate
26
+
ModuleDocstrings.generate(mod::Module)
27
+
28
+
Return an API summary string for mod.
29
+
30
+
The summary is assembled from all docstrings in the package, picking the
31
+
first sentence of each docstring. Expect to need to edit these by hand to
0 commit comments