Add prompting docs tests

[jxnl]

when you add docs in one block run

pytest tests/llm/test_openai/docs/test_prompt_tips.py --update-examples

instead of adding prints manually. Please make sure that everything is defined in functions and included in

if __name__ == "__main__": 
   stuff()

The goal is to allow people to copy and paste examples and modify them themselves. This will be what makes it useful. You should also avoid using all the academic names. Rewrite it as "Tips to Make Your Prompts Better." And describe what it actually does, rather than some random acronym.

---

:rocket:	This description was created by Ellipsis for commit 8222f831ec5d042185cf7ba95dfff62d04071633

Summary:

Adds tests for documentation examples and updates markdown files to include example outputs in comments, with instructions for running and updating examples using pytest.

Key points:

• Adds tests for documentation examples in docs/prompting and docs/prompting/zero_shot.
• Updates markdown files to include example outputs in comments.
• Updated docs/prompting/zero_shot/emotion_prompting.md to include example outputs in comments.
• Updated docs/prompting/zero_shot/re2.md to include example outputs in comments.
• Updated docs/prompting/zero_shot/role_prompting.md to include example outputs in comments.
• Updated docs/prompting/zero_shot/s2a.md to include example outputs in comments.
• Updated docs/prompting/zero_shot/simtom.md to include example outputs in comments.
• Updated docs/prompting/zero_shot/style_prompting.md to include example outputs in comments.
• Added tests/llm/test_openai/docs/test_prompt_tips.py to automate validation of documentation examples using pytest.
• Run pytest tests/llm/test_openai/docs/test_prompt_tips.py --update-examples to update examples.
• Ensure everything is defined in functions and included in if __name__ == "__main__": stuff().
• Avoid academic names; use "Tips to Make Your Prompts Better" and describe functionality clearly.

---

Generated with :heart: by ellipsis.dev

[cloudflare-pages[bot]]

Deploying instructor with    Cloudflare Pages

Latest commit:	8222f83
Status:	✅  Deploy successful!
Preview URL:	https://a4838c73.instructor.pages.dev
Branch Preview URL:	https://add-prompting-docs-tests.instructor.pages.dev

View logs