docs(developer-guide): fix undefined variable in example and improve …#6192
Open
praharsh777 wants to merge 1 commit intoaden-hive:mainfrom
Open
docs(developer-guide): fix undefined variable in example and improve …#6192praharsh777 wants to merge 1 commit intoaden-hive:mainfrom
praharsh777 wants to merge 1 commit intoaden-hive:mainfrom
Conversation
…code block formatting
This file contains hidden or 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
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.
Description
This PR introduces small documentation improvements to
docs/developer-guide.md.While reviewing the developer guide, I noticed that a Python example in the Code Style section referenced an undefined variable (
ticket_id) in the return statement. Since this variable was not defined anywhere in the function, it could confuse developers reading the example. The example was updated to return a defined value usingcustomer_idinstead.Additionally, the Codex CLI example block was updated to include a
textlanguage tag for better Markdown formatting and consistency with other code blocks in the documentation.These are documentation-only changes and do not modify any framework functionality.
Type of Change
Related Issues
N/A
Changes Made
ticket_id) in the Python example indeveloper-guide.mdcustomer_idtextlanguage tag to the Codex CLI example block for improved formattingTesting
Documentation-only changes. No code execution or automated tests were required.
cd core && pytest tests/)cd core && ruff check .)Checklist