docs: clarify output_dir behavior in medication_examples.md #15
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the code example in
docs/examples/medication_examples.md
to clarify how theoutput_dir
parameter affects where the output file is saved when usinglx.io.save_annotated_documents
.What's Changed
output_dir="."
in the example to ensure the file is saved in the current working directory.output_dir
istest_output/
, which may not match user expectations.Why This Matters
The previous example could confuse users, as it implied that setting
output_name
alone controls the full file path. In practice, the file is saved to thetest_output/
directory by default. This clarification improves usability and prevents unnecessary debugging.Related Issue
Fixes #8
☑️ I have signed the Google CLA.