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

Fixes links docs typos #478

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Fixes links docs typos #478

merged 1 commit into from
Dec 13, 2024

Conversation

skrawcz
Copy link
Contributor

@skrawcz skrawcz commented Dec 13, 2024

Corgi example just didn't work.
Others had typos and bad links.

Changes

How I tested this

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.

Important

Fixes typos and incorrect links in documentation files agent-patterns.md and simple-example.rst.

  • Documentation Fixes:
    • Corrects file paths in agent-patterns.md for code templates to include .py extension.
    • Updates URL in simple-example.rst for langchain to https://langchain.com.

This description was created by Ellipsis for 0dad115. It will automatically update as commits are pushed.

Corgi example just didn't work.
Others had typos and bad links.
Copy link

@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 0dad115 in 16 seconds

More details
  • Looked at 62 lines of code in 3 files
  • Skipped 1 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/getting_started/simple-example.rst:83
  • Draft comment:
    The link to langchain has been corrected. Ensure that the new link is valid and points to the intended resource.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR fixes a broken link in the documentation, which is a valid change. The new link seems correct based on the context provided.

Workflow ID: wflow_C22qtWyzkFlrk08T


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

Copy link

github-actions bot commented Dec 13, 2024

A preview of is uploaded and can be seen here:

https://burr.dagworks.io/pull/478

Changes may take a few minutes to propagate. Since this is a preview of production, content with draft: true will not be rendered. The source is here: https://github.com/DAGWorks-Inc/burr/tree/gh-pages/pull/478/

@skrawcz skrawcz merged commit bc3af0d into main Dec 13, 2024
11 checks passed
@skrawcz skrawcz deleted the fix_docs_examples branch December 13, 2024 22:11
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