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

docs: small formatting fixes #427

Merged
merged 1 commit into from
Feb 12, 2024
Merged

docs: small formatting fixes #427

merged 1 commit into from
Feb 12, 2024

Conversation

ryanhalliday
Copy link
Contributor

@ryanhalliday ryanhalliday commented Feb 11, 2024

Just some small formatting fixes for the docs that I noticed.

This project looks awesome by the way!

Bugs:
entity_resolution
search
action_items


Ellipsis 🚀 This PR description was created by Ellipsis for commit 1b7efe3.

Summary:

This PR improves the readability of the documentation by adding indentation to the 'Motivation' sections in two files and correcting a code block in another file.

Key points:

  • Added indentation to the 'Motivation' section in /docs/examples/action_items.md and /docs/examples/entity_resolution.md.
  • Changed python hl_line code block to python in /docs/examples/search.md.

Generated with ❤️ by ellipsis.dev

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 entire PR up to commit 1b7efe3

See details

Workflow ID: wflow_kosNNmXdE0bd5FAu

  • Reviewed 43 lines of code across 3 files in 7 second(s).
  • Skipped files: [none]
    • If you think a file was skipped (or not skipped) in error, please contact us.
  • Confidence threshold (set by ellipsis.yaml): 85%
  • Drafted 1 additional comments.
View 1 draft comments

These comments were drafted by Ellipsis, but were filtered out of the final review. They're included here so you can see our internal thought process and help you configure your ellipsis.yaml.

Drafted 1 comments under confidence threshold

Filtered comment at docs/examples/search.md:13

Confidence changes required: 0%

Commentary: The PR is about formatting fixes in the documentation. The changes are mostly about indentation and removing a highlighting line in a code block. I don't see any issues with the changes made. The changes are consistent with the markdown syntax and do not alter the meaning or readability of the documentation.

The changes made in this PR are appropriate and improve the readability of the documentation. The removal of the hl_line in the code block does not affect the code's functionality or readability.


Something look wrong? You can customize Ellipsis by editing the ellipsis.yaml for this repository.

Generated with ❤️ by ellipsis.dev

@jxnl jxnl merged commit adf7c5f into jxnl:main Feb 12, 2024
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.

2 participants