[DOC] Enhance Docstrings of Flows Core Public Functions

[EmanAbdelhaleem]

Metadata

• Reference Issue: [DOC] Add Usage Examples to Core Function Docstrings #1538

Details

enhance the docstrings of flows core public functions, add examples, parameter default, parameter type..etc

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.05%. Comparing base (bd8ae77) to head (618b9b4).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1569      +/-   ##
==========================================
- Coverage   79.14%   79.05%   -0.10%     
==========================================
  Files          36       36              
  Lines        4320     4320              
==========================================
- Hits         3419     3415       -4     
- Misses        901      905       +4     

☔ View full report in Codecov by Sentry.
📢 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.