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

Improve Clarity and Consistency in README #990

Merged
merged 3 commits into from
Nov 20, 2024
Merged

Conversation

Anik2812
Copy link
Contributor

This PR refines the README by fixing grammar issues, improving sentence flow, and ensuring consistency in tone and formatting. It enhances clarity around concepts like LLM behavior, state management, and tool usage, making the documentation more concise and developer-friendly.

Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

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

@Anik2812 "define, "refine", and "freeform state" were correct before your changes

"todo" -> "to-do" is an idiosyncratic style choice

I'd be happy to approve this if you revert all but the actual misspellings

@Anik2812
Copy link
Contributor Author

Anik2812 commented Nov 4, 2024

Thank you for the feedback! I've double-checked the document, and there are no spelling errors present. I’ve kept 'define,' 'refine,' 'freeform state,' and 'todo' as they were originally. And also reverted back to the original.

Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

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

three misspellings here but otherwise it looks good!

docs/docs/interactive/applications.md Outdated Show resolved Hide resolved
docs/docs/interactive/applications.md Outdated Show resolved Hide resolved
docs/docs/interactive/applications.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

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

thank you!

@zzstoatzz zzstoatzz merged commit bd5887b into PrefectHQ:main Nov 20, 2024
2 checks passed
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