Skip to content

Commit ca02c3d

Browse files
committed
[docs][exported_values] fix missing section description
A significant part of a previous code review's suggestion was left out when applying the suggestion.
1 parent 13613a9 commit ca02c3d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/exported_values/EXPORTED_VALUES.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,19 @@ For more details about the command line arguments see [the more general Usage
161161
documentation](../USAGE.md).
162162

163163
The report section looks like:
164+
```
165+
.> UNUSED EXPORTED VALUES:
166+
=========================
167+
filepath:line: value
168+
169+
Nothing else to report in this section
170+
--------------------------------------------------------------------------------
171+
```
172+
The report line format is `filepath:line: value` with `filepath` the absolute
173+
path to the file (`.mli` if available, `.ml` otherwise) where `value` is
174+
declared, `line` the line index in `filepath` at which `value` is declared, and
175+
`value` the path of the value within its compilation unit (e.g. `M.x`).
176+
There can be any number of such lines.
164177

165178
The expected resolution for an unused exported value is to remove it from the
166179
`.mli` if there is one, or the `.ml` otherwise.

0 commit comments

Comments
 (0)