Improve content generation prompt to reduce over-generation #16333
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I focused on cases where we're inserting doc comments or annotations above symbols. I added 5 new examples to the content generation prompt, covering various scenarios: 1. Inserting documentation for a Rust struct 2. Writing docstrings for a Python class 3. Adding comments to a TypeScript method 4. Adding a derive attribute to a Rust struct 5. Adding a decorator to a Python class These examples demonstrate how to handle different languages and common tasks like adding documentation, attributes, and decorators. To improve context integration, I've made the following changes: 1. Added a `transform_context_range` that includes 3 lines before and after the transform range 2. Introduced `rewrite_section_prefix` and `rewrite_section_suffix` to provide more context around the section being rewritten 3. Updated the prompt template to include this additional context in a separate code snippet
cla-bot
bot
added
the
cla-signed
jvmncs
reviewed
Aug 16, 2024
|
|
||
| Immediately start with the following format with no remarks: | ||
|
|
||
| ``` | ||
| \{{REWRITTEN_CODE}} | ||
| {{REWRITTEN_CODE}} |
There was a problem hiding this comment.
due to this no longer being escaped, this section will get rendered away by handlebars, right? is that intended?
This was referenced Aug 16, 2024
jvmncs
added a commit
that referenced
this pull request
Aug 16, 2024
Fixed the output format section of the content_prompt.hbs template getting rendered away by handlebars. Also fixed a leftover hardcoded "Rust" in the rewrite section snippet. (follow-up to #16333) Release Notes: - N/A
nathansobo
added a commit
that referenced
this pull request
Aug 16, 2024
I focused on cases where we're inserting doc comments or annotations above symbols. I added 5 new examples to the content generation prompt, covering various scenarios: 1. Inserting documentation for a Rust struct 2. Writing docstrings for a Python class 3. Adding comments to a TypeScript method 4. Adding a derive attribute to a Rust struct 5. Adding a decorator to a Python class These examples demonstrate how to handle different languages and common tasks like adding documentation, attributes, and decorators. To improve context integration, I've made the following changes: 1. Added a `transform_context_range` that includes 3 lines before and after the transform range 2. Introduced `rewrite_section_prefix` and `rewrite_section_suffix` to provide more context around the section being rewritten 3. Updated the prompt template to include this additional context in a separate code snippet Release Notes: - Reduced instances of over-generation when inserting docs or annotations above a symbol.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I focused on cases where we're inserting doc comments or annotations above symbols.
I added 5 new examples to the content generation prompt, covering various scenarios:
These examples demonstrate how to handle different languages and common tasks like adding documentation, attributes, and decorators.
To improve context integration, I've made the following changes:
transform_context_rangethat includes 3 lines before and after the transform rangerewrite_section_prefixandrewrite_section_suffixto provide more context around the section being rewrittenRelease Notes: