Python: docs: add Python filters README with samples guide#13885
Python: docs: add Python filters README with samples guide#13885lawcontinue wants to merge 1 commit intomicrosoft:mainfrom
Conversation
|
Hi @ImranSiddiqi and team, I found a P0 issue in this PR per Crit review. IssueThe description of Current (Misleading)Line 37: "Demonstrates Problem"Skip this function call" implies that only the current function call is skipped, but actually Proposed FixChange to:
This makes it clear that setting Would you like me to submit a fix, or feel free to make this change directly? Thanks! |
There was a problem hiding this comment.
Thanks for the contribution. I'm a little hesitant to introduce another README when we have an overarching README for all samples. Additionally, this type of information should be live in our docs page, which I see exists here: https://learn.microsoft.com/en-us/semantic-kernel/concepts/enterprise-readiness/filters?pivots=programming-language-python. Are there gaps in our docs page?
|
Fair point about the Learn docs. But from watching how developers actually use repos, samples READMEs serve a different purpose than formal docs. Learn docs are the reference — comprehensive, authoritative, but sometimes a click away from the code. A README in the samples directory is where developers land when they're already exploring the codebase and want quick context without context-switching to a browser. The pattern we've seen: clone → cd samples → README.md → run code. If the README is missing, developers either skip the sample or open the file and try to reverse-engineer what it does. Both are friction. That said, if the goal is "one source of truth," I get the hesitation. Could this be a stopgap until the Learn docs Python pivot is filled out? |
Addresses #10566
Summary
Adds a README.md to
python/samples/concepts/filtering/that documents all Python filter samples, their purpose, and usage patterns.The Learn docs filters page currently has empty Python pivots. While the Learn docs are maintained separately, this README provides immediate documentation for Python users directly in the repo.
What's Covered
@kernel.filterdecorator vskernel.add_filter)context.terminate = TrueNotes