Fix technical errors and clarity issues in Drawing Using Procedures guide - #41
Fix technical errors and clarity issues in Drawing Using Procedures guide#41stantheman96 wants to merge 1 commit into
Conversation
Correct Python run commands, fix x/y coordinate wording, and improve grammar and clarity throughout the guide.
Rhinoatron
left a comment
There was a problem hiding this comment.
Amazing work on this guide. The main technical fixes look correct: the Python run commands now reference program.py, and the x/y coordinate wording has been corrected so x maps to column and y maps to row.
I’d like to request a few small changes before approving:
- Some useful code formatting/linking was removed while improving the wording. For example,
close_all_windows(),fill_rectangle,draw_rectangle,COLOR_, andrefresh_screenshould stay formatted as code, and the Close Window API reference should ideally remain linked. - Could you please confirm the page has been checked in the local Starlight site, rather than only through GitHub’s rendered preview? GitHub preview does not always match the actual documentation site rendering.
I also checked for duplicate PRs touching this same guide and did not find another current duplicate.
Once those small documentation and rendering checks are addressed, I’ll be happy to take another look. Many thanks
jankiluitel
left a comment
There was a problem hiding this comment.
Thanks for improving the technical accuracy and clarity of the Drawing Using Procedures guide. The grammar improvements and the correction of the x/column and y/row explanation look good.
I noticed that the code-language section appears to contain two Python TabItems with the same skm python3 program.py command. Could you please check whether one of these tabs should be for another language or whether the duplicate should be removed?
Once that is confirmed/fixed, this looks good from my side.
Correct Python run commands, fix x/y coordinate wording, and improve grammar and clarity throughout the guide.
Description
Corrects technical and documentation issues in the Drawing Using Procedures guide, including incorrect Python run commands, incorrect x/y row-column wording, and several grammar and clarity issues.
Type of change
expected)
How Has This Been Tested?
Reviewed the rendered GitHub preview and verified that the updated documentation displays correctly. Confirmed the Python commands now reference program.py and the x/y coordinate wording is corrected.
Checklist
I have performed a self-review of my own code
I have made corresponding changes to the documentation
Folders and Files Added/Modified
Please list the folders and files added/modified with this pull request and delete options that are not relevant.
src/content/docs/guides/graphics/drawing-using-procedures.mdx