docs: Use column description in skill schema example

[Mathis Derenne (mathisdrn)]

Motivation

Having comment lines (#: ) before column definitions in the SKILL.md code examples leads coding agents to produce verbose dataframe schemas that prepend comments above every column definition.

Changes

• Updated MyHouseSchema in skills/SKILL.md to use the native description="..." parameter on column definitions (description="Number of rooms", description="Area of the house") instead of preceding #: comments.
• Refined the schema constraint guidelines to prefer the description argument for column contents while allowing comments for context not strictly schema-related or interface-specific.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (9c5c38f) to head (20471a9).

Additional details and impacted files

@@             Coverage Diff             @@
##             main      #395      +/-   ##
===========================================
+ Coverage   99.88%   100.00%   +0.11%     
===========================================
  Files          46        46              
  Lines        2590      2590              
===========================================
+ Hits         2587      2590       +3     
+ Misses          3         0       -3     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

This PR updates the dataframely skill documentation to discourage schema column descriptions being written as standalone comment lines, and instead uses the native description="..." argument on column definitions to reduce verbosity and improve agent output consistency.

Changes:

• Updated the MyHouseSchema example to use description="..." on column definitions (replacing #: comment lines).
• Updated schema constraint guidance text to recommend the description argument for “what” descriptions of column contents.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Mathis Derenne (mathisdrn)]

The # Shared primary key component with MyHouseSchema comment in MyStreetSchema was re-added because it relate to documentation rather than reference code example for AI agents.