Skip to content

Commit

Permalink
DOC: clarify DUECREDIT_REPORT_ALL usage
Browse files Browse the repository at this point in the history
  • Loading branch information
mvdoc committed May 30, 2016
1 parent 6754951 commit 150b717
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -181,10 +181,10 @@ depicting instructional materials -- textbooks etc on the topic):
[11] Sibson, R., 1973. SLINK: an optimally efficient algorithm for the single-link cluster method. The Computer Journal, 16(1), pp.30–34.

The `DUECREDIT_REPORT_ALL` flag allows one to output all the references
that were available but not directly used in the script. Compared to
the previous example, the following output additionally shows a reference
for scikit-learn since `example_scipy.py` uses an uncited function from
that package.
for the modules that lack objects or functions with citations.
Compared to the previous example, the following output additionally
shows a reference for scikit-learn since `example_scipy.py` uses
an uncited function from that package.

$> DUECREDIT_REPORT_TAGS=* DUECREDIT_REPORT_ALL=1 duecredit summary

Expand Down

0 comments on commit 150b717

Please sign in to comment.