Skip to content

OrbiterInclude docs and examples#114

Merged
fritz-astronomer merged 1 commit intomainfrom
include_docs
Nov 21, 2025
Merged

OrbiterInclude docs and examples#114
fritz-astronomer merged 1 commit intomainfrom
include_docs

Conversation

@fritz-astronomer
Copy link
Contributor

  • docs(object): add OrbiterInclude docs and examples

@fritz-astronomer fritz-astronomer self-assigned this Nov 21, 2025
@fritz-astronomer fritz-astronomer added the documentation Improvements or additions to documentation label Nov 21, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation and usage examples to the OrbiterInclude class, explaining how to create included files in an Orbiter project and integrate them with DAGs and operators.

  • Enhanced class docstring with practical examples
  • Added code examples showing file creation and integration with PythonOperator
  • Clarified the typical location and purpose of included files

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.44%. Comparing base (b3ee237) to head (6fd5367).
⚠️ Report is 70 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #114      +/-   ##
==========================================
+ Coverage   78.92%   82.44%   +3.51%     
==========================================
  Files          35       51      +16     
  Lines        1362     1891     +529     
==========================================
+ Hits         1075     1559     +484     
- Misses        287      332      +45     

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

@fritz-astronomer fritz-astronomer merged commit c051394 into main Nov 21, 2025
8 checks passed
@fritz-astronomer fritz-astronomer deleted the include_docs branch November 21, 2025 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants