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

Small documentation updates #313

Merged
merged 3 commits into from
Jan 1, 2024
Merged

Small documentation updates #313

merged 3 commits into from
Jan 1, 2024

Conversation

CSRessel
Copy link
Contributor

I reading through all the docs today, and just saw two sentences that could be fixed for clarity (also added some inline code formatting where appropriate)

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!

Summary:

This PR improves the clarity and readability of the documentation by fixing typos, adding inline code formatting, and enhancing sentence structure in 'docs/index.md' and 'docs/why.md'.

Key points:

  • Fixed typos in 'docs/index.md' and 'docs/why.md'.
  • Added inline code formatting in 'docs/index.md' and 'docs/why.md'.
  • Improved sentence structure in 'docs/why.md'.

Generated with ❤️ by ellipsis.dev

@jxnl jxnl merged commit a1badee into instructor-ai:main Jan 1, 2024
3 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