{"id":184,"date":"2022-01-22T18:58:11","date_gmt":"2022-01-22T18:58:11","guid":{"rendered":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/?p=184"},"modified":"2022-02-18T16:48:22","modified_gmt":"2022-02-18T16:48:22","slug":"code-style-guidelines","status":"publish","type":"post","link":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/2022\/01\/22\/code-style-guidelines\/","title":{"rendered":"Code Style Guidelines"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"processing-style-guidelines\">Processing Style Guidelines<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Your code should be well formatted and easy to understand and read. Use comments where they will be helpful to you and to me. You have flexibility to choose your own formatting conventions. They should be applied consistently.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Header Comments<\/strong><br>Every program you write should contain a header comment that describes the program and includes other important information.&nbsp; It must include the following information:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>The assignment number and name<\/li><li>Your name<\/li><li>Your UNM e-mail address<\/li><li>The class number and name<\/li><li>The date the assignment was submitted<\/li><li>A short description of your program<\/li><\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">For example:<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\/*****************************************<br>&nbsp;* Small Assignment 2: Processing and Turtle Geometry<br>&nbsp;* Name:&nbsp;&nbsp;&nbsp; Rudy Gurule<br>&nbsp;* E-mail:&nbsp;&nbsp;rgurule@unm.edu<br>&nbsp;* Course:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CS491, Computational Fabrication<br>&nbsp;* Submitted:&nbsp;&nbsp;&nbsp; 2\/5\/2022<br>&nbsp;*<br>&nbsp;* This program includes several different features.<br> * To plot a polar plot, press the p key.<meta charset=\"utf-8\"><br> * To draw a circle with a turtle, press the t key.<meta charset=\"utf-8\"><br> * To draw a flower, press the f key.<meta charset=\"utf-8\"><br> * To draw a cool turtle path, press the c key.<br>***********************************************\/<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"grasshopper-style-guidelines\">Grasshopper Style Guidelines<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Use the &#8220;Scribble&#8221; tool in Grasshopper to create text. You can find the tool under Params &#8211;> Util, or by double clicking on the Grasshopper canvas and typing &#8220;Scribble&#8221;. See the image below.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment-1024x388.jpg\" alt=\"\" class=\"wp-image-1197\" width=\"512\" height=\"194\" srcset=\"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment-1024x388.jpg 1024w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment-300x114.jpg 300w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment-768x291.jpg 768w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment-1140x432.jpg 1140w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment-920x349.jpg 920w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment-575x218.jpg 575w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment-380x144.jpg 380w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment.jpg 1378w\" sizes=\"auto, (max-width: 512px) 100vw, 512px\" \/><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">The comment should include al of the same information listed above (course information, name, email, etc.). If you want to give your comment some color, select the top level Edit menu and then select Group. This will create a colored box around your scribble. See below for an example. <\/p>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2-1024x671.jpg\" alt=\"\" class=\"wp-image-1198\" width=\"512\" height=\"336\" srcset=\"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2-1024x671.jpg 1024w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2-300x197.jpg 300w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2-768x503.jpg 768w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2-1140x747.jpg 1140w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2-920x603.jpg 920w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2-575x377.jpg 575w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2-380x249.jpg 380w, https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-content\/uploads\/2022\/02\/grasshopper_comment2.jpg 1306w\" sizes=\"auto, (max-width: 512px) 100vw, 512px\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"python-style-guidelines\">Python Style Guidelines<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">TBD<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Processing Style Guidelines Your code should be well formatted and easy to understand and read. Use comments where they will be helpful to you and to me. You have flexibility to choose your own formatting conventions. They should be applied consistently. Header CommentsEvery program you write should contain a header comment that describes the program and includes other important information.&nbsp; [&hellip;]<\/p>\n","protected":false},"author":37,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7],"tags":[],"class_list":["post-184","post","type-post","status-publish","format-standard","hentry","category-references-and-tutorials"],"_links":{"self":[{"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/posts\/184","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/users\/37"}],"replies":[{"embeddable":true,"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/comments?post=184"}],"version-history":[{"count":3,"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/posts\/184\/revisions"}],"predecessor-version":[{"id":1199,"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/posts\/184\/revisions\/1199"}],"wp:attachment":[{"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/media?parent=184"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/categories?post=184"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/handandmachine.org\/classes\/computational_fabrication\/wp-json\/wp\/v2\/tags?post=184"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}