Skip to content

Commit 8f99e79

Browse files
authored
Updated README to add --question usage info (#35)
1 parent 1689e25 commit 8f99e79

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,19 @@ Models:
197197

198198
- When the `--output` argument is not given, the prompt used and generated response will be sent to stdout in the format selected by `--output_template`.
199199
- When the `--output_template` argument is not given it will default to `response_only` which is only the response from the model
200+
201+
## Question Extraction
202+
203+
Use `--question "<section name>"` to extract a specific section from a submission. Behavior depends on file type.
204+
205+
### Supported inputs
206+
- PDF: looks up section names in the PDF’s Table of Contents (TOC).
207+
208+
- Text / Markdown / Code (.txt, .md, .ipynb, .qmd): looks for Markdown-style headings (#, ##, ###, …).
209+
For code, write the heading in a comment line (e.g., ### Question 1 in Python). The extractor returns all content that belongs to that heading (up until the next heading at the same or higher level).
210+
211+
Matching is case-insensitive and normalizes smart quotes, dashes, and extra whitespace.
212+
200213
## Test Files
201214
- Any subdirectory of /test_submissions can be run locally. More examples can be added to this directory using a similar fashion.
202215

0 commit comments

Comments
 (0)