8000 Update SQL generation cookbook by damon-openai · Pull Request #1654 · openai/openai-cookbook · GitHub
[go: up one dir, main page]
Skip to content

Update SQL generation cookbook #1654

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 29, 2025
Merged

Update SQL generation cookbook #1654

merged 1 commit into from
Jan 29, 2025

Conversation

damon-openai
Copy link
Contributor

Summary

This PR makes a number of small improvements to the SQL generation cookbook:

  • Improve grammar and spelling
  • Fix some cell outputs (e.g. one of the early cells has the output cannot find .env file)
  • Add a commented cell with a commented !pip install command for convenience
  • Update some cells to provide either more feedback (where there was none) or less feedback (when it was overly verbose)
  • Switch from pprint to print for some prints for slightly nicer output. pprint wraps the strings in parens
  • Improve some code formatting for long lines to be more readable

Motivation

Why are these changes necessary? How do they improve the cookbook?

For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

colin-openai
colin-openai approved these changes Jan 29, 2025
View reviewed changes
Copy link
Collaborator
@colin-openai colin-openai left a comment

Choose a reason for hiding this comment

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

Like the clean-up happy to approve

@colin-openai colin-openai merged commit cb913c6 into main Jan 29, 2025
@colin-openai colin-openai deleted the damon-update-sqlgen branch January 29, 2025 07:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@colin-openai colin-openai colin-openai approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@damon-openai @colin-openai
0