Skip to content

Commit f2a5ae4

Browse files
committed
Add a README
1 parent 151168e commit f2a5ae4

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,32 @@
33
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaDocs.github.io/ModuleDocstrings.jl/stable)
44
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaDocs.github.io/ModuleDocstrings.jl/dev)
55
[![Build Status](https://github.com/JuliaDocs/ModuleDocstrings.jl/workflows/CI/badge.svg)](https://github.com/JuliaDocs/ModuleDocstrings.jl/actions)
6-
[![Build Status](https://travis-ci.com/JuliaDocs/ModuleDocstrings.jl.svg?branch=master)](https://travis-ci.com/JuliaDocs/ModuleDocstrings.jl)
76
[![Coverage](https://codecov.io/gh/JuliaDocs/ModuleDocstrings.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaDocs/ModuleDocstrings.jl)
7+
8+
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
32+
produce something truly useful.
33+
34+
```

0 commit comments

Comments
 (0)