Skip to content

Commit ba74f05

Browse files
committed
Clarify limit argument help text and add documentation
1 parent 704fa28 commit ba74f05

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

scripts/1-fetch/arxiv_fetch.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,14 +272,24 @@
272272

273273
# parsing arguments function
274274
def parse_arguments():
275-
"""Parse command-line options, returns parsed argument namespace."""
275+
"""Parse command-line options, returns parsed argument namespace.
276+
277+
Note: The --limit parameter sets the total number of papers to fetch
278+
across all search queries, not per query. ArXiv API recommends
279+
maximum of 30000 results per session for optimal performance.
280+
"""
276281
LOGGER.info("Parsing command-line options")
277282
parser = argparse.ArgumentParser(description=__doc__)
278283
parser.add_argument(
279284
"--limit",
280285
type=int,
281286
default=DEFAULT_FETCH_LIMIT,
282-
help=f"Limit papers to fetch (default: {DEFAULT_FETCH_LIMIT})",
287+
help=(
288+
f"Total limit of papers to fetch across all search queries "
289+
f"(default: {DEFAULT_FETCH_LIMIT}). Maximum recommended: 30000. "
290+
f"Note: Individual queries limited to 500 results (implementation choice). "
291+
f"See ArXiv API documentation: https://info.arxiv.org/help/api/user-manual.html"
292+
),
283293
)
284294
parser.add_argument(
285295
"--enable-save",

0 commit comments

Comments
 (0)