Skip to content

Commit bce6337

Browse files
author
John Halloran
committed
docs: explain the current entrypoint when the help command is used
1 parent d395a30 commit bce6337

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

src/diffpy/stretched_nmf/snmf_app.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ def main():
88
prog="snmf",
99
description=(
1010
"A python package implementing the stretched NMF algorithm.\n\n"
11+
"Currently, this project is used by importing "
12+
"`SNMFOptimizer` in Python rather than through a command-line "
13+
"workflow.\n\n"
1114
"For more information, visit: "
1215
"https://github.com/diffpy/diffpy.stretched-nmf/"
1316
),

0 commit comments

Comments
 (0)