Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates first dataflow docs #1245

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Updates first dataflow docs #1245

merged 1 commit into from
Dec 2, 2024

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Dec 2, 2024

They weren't up to date. Also added note about disabling plugins.

Changes

  • docs

How I tested this

  • locally

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

They weren't up to date. Also added note about disabling plugins.
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 9f6a239 in 5 seconds

More details
  • Looked at 54 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/get-started/your-first-dataflow.rst:109
  • Draft comment:
    Consider providing a complete example for dr.visualize_execution or remove the comment if not intended for use.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The comment on line 109 suggests using a PNG file for visualization, but the code is commented out. It would be more helpful to provide a complete example or remove the comment if it's not intended to be used.
2. docs/get-started/your-first-dataflow.rst:133
  • Draft comment:
    Consider adding this note about disabling autoloading of extensions to the Sphinx documentation under docs/how-tos/extensions-autoloading.rst for better visibility and reference.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The note about disabling autoloading of extensions is useful and should be documented in the appropriate section for future reference.

Workflow ID: wflow_YGIAClWhmRvWeiSM


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@skrawcz skrawcz merged commit a64393e into main Dec 2, 2024
24 checks passed
@skrawcz skrawcz deleted the add_disable branch December 2, 2024 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant