<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Mo Kweon on Medium]]></title>
        <description><![CDATA[Stories by Mo Kweon on Medium]]></description>
        <link>https://medium.com/@kkweon?source=rss-6f7bb25e7a0c------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/0*h9fmEVEzVleSVsEI.</url>
            <title>Stories by Mo Kweon on Medium</title>
            <link>https://medium.com/@kkweon?source=rss-6f7bb25e7a0c------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Fri, 20 Nov 2026 06:49:26 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@kkweon/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[사람들이 잘 안알려주는 GitHub 팁]]></title>
            <link>https://medium.com/@kkweon/%EC%82%AC%EB%9E%8C%EB%93%A4%EC%9D%B4-%EC%9E%98-%EC%95%88%EC%95%8C%EB%A0%A4%EC%A3%BC%EB%8A%94-github-%ED%8C%81-941e4d644402?source=rss-6f7bb25e7a0c------2</link>
            <guid isPermaLink="false">https://medium.com/p/941e4d644402</guid>
            <category><![CDATA[github]]></category>
            <category><![CDATA[git]]></category>
            <dc:creator><![CDATA[Mo Kweon]]></dc:creator>
            <pubDate>Sat, 17 Aug 2019 15:08:51 GMT</pubDate>
            <atom:updated>2019-08-20T22:50:38.744Z</atom:updated>
            <content:encoded><![CDATA[<h3>계정명과 리포명을 정할 때 잘 정한다</h3><ul><li>짧고 간결하게 한다.</li><li>특수문자, 언더바(_), 하이픈(-) 등을 피한다.</li><li>CamelCase를 피한다.</li></ul><p>왜냐하면, 계정명 리포명이 바로 URL이 된다. <br>위 방식대로 하면 알아보기도 쉽고 기억하기도 쉽다.</p><p>Prefers</p><ul><li>github.com/kkweon</li><li>github.com/kkweon/concise</li><li>kkweon.github.io/my-package</li></ul><p>over</p><ul><li>github.com/DonOtDoThis</li><li>github.com/kyung-mo-kweon</li><li>github.com/kkweon/SomeWeird-Repo_Name</li><li>DontDoThis.github.io/YourPackageName</li></ul><h3>다른 사람이 보내준 PR은 내가 수정할 수 있다.</h3><p>kkweon/my-repo 를 abcd가 포크해서 PR 을 보내면 abcd/my-repo 에 쓰기 권한이 생긴다. 아주 간단한 nit pick의 경우 굳이 상대방에게 부탁하지 않고 내가 수정 후 머지할 수 있는 것이다.</p><pre>PR 받는 쪽: kkweon/my-repo:master<br>PR 보내는 쪽: abcd/my-repo:some-branch</pre><p>이런 경우 나는 아래와 같은 방식으로 상대방의 PR을 수정할 수 있다.</p><pre>git clone github.com/abcd/my-repo<br>git checkout some-branch<br># git 잘쓰시는 분들은 clone 대신 branch 만들고 pull 해주셔도 된다</pre><pre># 이제 PR 내용 수정하고<br>git push</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*KFSd6btCFXFfZsAqGldHYA.jpeg" /><figcaption>상대방의 PR을 수정 후 Merge 한 경우</figcaption></figure><h3>커밋이 많은(2 이상) PR의 경우 Squash Merge, 아니라면 Rebase Merge를 해준다</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/881/0*-fLt-LpFFqYX962D.png" /><figcaption>커밋이 1개일 경우 Rebase, 커밋이 2개 이상일 경우 Squash, 그 이외에 1번을 사용해 커밋 히스토리 오염을 방지한다</figcaption></figure><p>하나의 PR을 만들기 위해 여러개의 커밋으로 이루어질 수 있다. 하지만 Master로 Merge 할때는 squash merge를 해준다.</p><p>보통 PR이 1개의 feature에 해당하기 때문이다.</p><p>Squash Merge를 하지 않는다면, Update README.md 같은 의미없는 커밋들로 커밋 히스토리를 엉망으로 만들어 결국 커밋 히스토리를 알아볼 수 없게 만든다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*MjeaV3adlbZK4aHtvQZQVg.jpeg" /><figcaption>Squash Merge가 안되어서 단순 오탈자 수정 Update *.md 커밋이 수십개가 Master 히스토리에 들어왔다</figcaption></figure><h3>코드리뷰는 가능하면 suggestion을 사용한다</h3><p>물론 좀더 high level 디자인 문제같은경우는 안되는 경우도 있지만, 간단한 경우 suggestion을 사용해 내 의도를 확실히 전달해 준다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/888/1*TFwMaDMiopYeOCfvwBplZw.jpeg" /><figcaption>여기서 suggestion 내용을 변경하면 된다</figcaption></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/698/1*vnlDbPMBZfFCi3BXbJTgDA.jpeg" /></figure><p>그러면 상대방 입장에서 클릭 1번으로 바로 피드백은 반영할 수 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/789/0*TKPExP25zQVwrXj8.png" /></figure><h3>Demo Site가 있다면 Website로 등록해준다.</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*UrmZ0wFOz3iZH94TXN159Q.jpeg" /></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*i7JsU-lZ5wDblRkwYmib6A.jpeg" /><figcaption>클릭 한번으로 데모사이트를 들어가볼 수 있다</figcaption></figure><h3>데모 웹사이트도 만들어 준다</h3><p>라이브러리면 doc 문서일 수 도 있고 프로젝트면 데모프로젝트를 Heroku에 자동 배포할 수 도 있다. 게다가 무료이다.</p><p>다른 사람에게 어떤 프로젝트인지 알려주는데 데모 만큼 적당한게 없다.</p><h3>LICENSE를 넣는다</h3><p>많은 분들이 무시하는 부분인데 리포를 봤는데 LICENSE가 없으면 다른 사람이 사용할 수 없다. 아래 두가지는 모든 Repo에 만들어주자.</p><ul><li>LICENSE</li><li>README.md</li></ul><h3>자동화</h3><p>CI를 단순히 테스트 도구로서만 아니라 자동화 도구 혹은 Task Runner로 사용한다. 예를 들면 최근에는 PR이 머지되면 GitHub org에 invite를 보내는 기능을 travis를 이용했다.</p><p>이 외에도 코드 리뷰 해주는 툴이나 그린키퍼(Greenkeeper) 처럼 최신 버전을 테스트해주고 PR을 보내주는 자동화 툴을 이용한다.</p><p>가능한 예시</p><ul><li>PR이 오면 테스트를 실행한다 <a href="https://travis-ci.org/">https://travis-ci.org/</a></li><li>PR이 오면 기본적인 코드 리뷰를 해준다 <a href="https://lgtm.com/">https://lgtm.com/</a></li><li>Dependency가 새로운 버전으로 업데이트 되면 자동으로 PR을 보내준다 <a href="https://greenkeeper.io/">https://greenkeeper.io/</a></li><li>PR이 머지되면 자동으로 배포한다 <a href="https://www.heroku.com/">https://www.heroku.com/</a></li></ul><h3>협업하는 Repo에는 Master에 Protection을 걸어준다.</h3><p>코드 리뷰를 통해서도 심각한 버그가 들어갈 수 도 있는데 그걸 누구나 마음대로 코드 리뷰 없이 커밋한다면? 자세한 내용은 굳이 쓰지 않겠다.</p><p>나도 모르는 사이에 master 브랜치를 바뀌는걸 방지한다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*eGrhzXsyIimRZeCkBrVNBw.jpeg" /></figure><h3>HUB를 사용하자</h3><p>초보때는 굳이 사용할 필요 없고 GitHub이 일상이 된 사람이라면 필수 도구이다. 깃헙 웹 인터페이스 대신 CLI를 사용할 수 있다.</p><p><a href="https://hub.github.com/">hub · the command-line wrapper for git</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=941e4d644402" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[GMAIL 제대로 활용하기]]></title>
            <link>https://medium.com/@kkweon/gmail-%EC%A0%9C%EB%8C%80%EB%A1%9C-%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0-7aa0e4429b05?source=rss-6f7bb25e7a0c------2</link>
            <guid isPermaLink="false">https://medium.com/p/7aa0e4429b05</guid>
            <category><![CDATA[email]]></category>
            <category><![CDATA[productivity]]></category>
            <category><![CDATA[생산성]]></category>
            <category><![CDATA[gmail]]></category>
            <category><![CDATA[이메일]]></category>
            <dc:creator><![CDATA[Mo Kweon]]></dc:creator>
            <pubDate>Sat, 03 Aug 2019 03:08:21 GMT</pubDate>
            <atom:updated>2019-08-03T08:06:28.591Z</atom:updated>
            <content:encoded><![CDATA[<p>회사에서 주로 이메일을 모든 업무에 사용하다보니 매일 100통 넘게 이메일을 받고 있습니다. 종종 놓치는 이메일이 생기게 되고 이메일을 제대로 관리하기 위해 알아보다가 아래 사내교육자료에서 아래 Quote를 보고 그동안 이메일을 제대로 활용하지 못하고 있다는 것을 알게 되었습니다 :O</p><blockquote>현재 Gmail Inbox에 메일이 5개 이상 있다면, Gmail을 제대로 사용하고 있지 않다 :D</blockquote><h3>Label 이해하기</h3><p>Gmail을 제대로 사용하기 위해서 Label을 제대로 이해해야 합니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/422/1*4KAzs-CCzKE06WeT8AzS_g.png" /><figcaption>Inbox와 All Mail</figcaption></figure><p>Label은 일종의 키워드 태깅과 비슷합니다. 키워드태깅으로 마치 폴더정리하듯이 이메일도 정리할 수 있게 됩니다.</p><p>그 예로 Inbox와 All Mail을 보시면,</p><ul><li>Inbox는 기본적으로 생성되는 Label입니다. 모든 필터링을 거치지 않은 메일은 기본적으로 Inbox Label이 붙게 됩니다. Inbox Label이 붙은 이메일이 모인 폴더가 바로 Inbox 입니다.</li><li>All Mail은 말그대로 받은 모든 이메일이 있는 곳입니다.</li></ul><p>그래서 이메일을 보시면 Archive와 Delete의 차이도 여기서 발생하는데 Archive는 Inbox Label을 지우기만 할 뿐 이메일을 삭제하지는 않습니다. 그래서 All Mail에 가보면 여전히 이메일을 찾을 수 있습니다. Delete는 완전히 휴지통에 보내는 것을 의미합니다.</p><h3>Multiple Inboxes</h3><p>여기서 설명을 위해 제가 사용하는 Label로 예시로 사용하겠습니다.</p><p>아래와 같이 두개의 Label을 생성합니다.</p><ul><li>To Do (해야 될 일)</li><li>Follow Up (기다려야 되는 일, 예: 메일 보내고 상대방 답장을 기다려야 되는 일)</li></ul><p>아래와 같이 설정에서 생성할 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/486/1*qvMJqcg0IohwrjwPY_-wrA.png" /><figcaption>Settings &gt; Labels &gt; Create new label</figcaption></figure><p>그러고 난 후, Settings &gt; Advanced &gt; Multiple Inboxes 를 Enable 해줍니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Z9mTL67YR5-a75P88zFSFQ.png" /></figure><p>그러면 Settings에서 Multiple Inboxes 탭이 보이게 됩니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*9rgAsQr22MD_Y21b35zbDw.png" /></figure><p>그 다음 위와 같이 Search Query를 작성합니다.</p><ul><li>is: starred</li><li>label: To Do</li><li>label: Follow Up</li></ul><p>그리고 저장한후 메인화면을 가보면 Inbox가 여러개 생성되었음을 알 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*DSfQ1tsU15Is_NWUNMArrQ.png" /><figcaption>Multiple Inbox 가 생성되었다</figcaption></figure><p>일종의 대시보드로 내가 할 일 은 무엇이고 새로운 메일들이 어떤 것들인지 바로 알 수 있게 됩니다.</p><h3>Label 달기</h3><p>이제 할일은 Inbox에 오는 이메일마다 읽고 Inbox Label을 제거한 후 적절한 Label을 추가해주기만 하면 됩니다. Gmail에서는 <strong>Move to</strong> 라는 기능을 제공합니다.</p><p>예를 들어,</p><ul><li>내가 해야 되는 경우, To Do</li><li>진행상황을 나중에 다시 확인해봐야 한다면, Follow up</li><li>스팸 메일일 경우, 바로 Delete</li><li>스팸은 아니고 애매할경우, 그냥 Archive.</li></ul><p>Gmail은 용량이 거의 무제한임으로 Delete 할 필요가 없지만 나중에 검색할 때 광고가 나오면 귀찮기 때문에 광고 메일은 삭제해줍니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*oPIydgyG0ErjT61YNolF0A.png" /><figcaption>적절한 Label을 선택해준다</figcaption></figure><h3>Label 자동으로 달기</h3><p>필터링을 이용해 Label을 자동으로 달 수 있습니다.</p><ul><li>Skip Inbox</li><li>Apply label “To Do”</li></ul><p>같은 형식으로 이메일이 오면 Inbox를 바로 스킵하고 갈 수 있도록 합니다.</p><p>여기서 팁은 이메일주소에 +를 사용해 태깅을 할 수 있습니다.</p><p>kkweon+아무거나써도@gmail.com이라고 쓰더라도 kkweon@gmail.com 메일과 받는 사람이 동일합니다.</p><p>그래서 kkweon+followup@gmail.com 이메일로 메일이 올경우 바로 Skip Inbox 해서 Label을 적용해주도록 합니다.</p><p>그러면 다른 사람에게 답장할때 <strong>bcc</strong>로 kkweon+followup@gmail.com 추가해서 follow up 을 쉽게 할 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Kwty6EaKl7BjXQAprvkReA.jpeg" /><figcaption>BCC로 followup을 하자</figcaption></figure><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*0z39_0c8N017UyefPSNiqw.png" /><figcaption>필터링 적용</figcaption></figure><p>필터링 및 레이블을 쉽게 추가하는 방법은 이메일에서 바로 <strong>Filter messages like this</strong> 를 통해 쉽게 할 수 있습니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*QJu5FCv4vT7ZsGVxdf7oHw.png" /></figure><p>그래서 Inbox에 오는 메일은 필터링할 수 있는 메일이라면 바로 적절한 Label을 생성 및 필터링을 하도록 합니다.</p><h3>단축키 사용하기</h3><p>&lt;SHIFT&gt; + ? 를 누를 경우 단축키가 보이게 됩니다. 처음에 적응하는데 시간이 좀 걸리지만 단축키에 익숙해지면 매우 빠르게 이메일을 처리할 수 있게 됩니다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*As1m4fIni5u34rowwxmz5g.png" /><figcaption>Gmail 단축키</figcaption></figure><h3>결론</h3><p>이메일을 평소에 많이 받지 않으면 와닿지 않을 수 도 있습니다. 그러나 위와 같은 방법을 사용해 Gmail로도 GTD(Getting Things Done)를 할 수 있습니다.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=7aa0e4429b05" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[파이썬 (doc) 스타일 가이드에 대한 정리]]></title>
            <link>https://medium.com/@kkweon/%ED%8C%8C%EC%9D%B4%EC%8D%AC-doc-%EC%8A%A4%ED%83%80%EC%9D%BC-%EA%B0%80%EC%9D%B4%EB%93%9C%EC%97%90-%EB%8C%80%ED%95%9C-%EC%A0%95%EB%A6%AC-b6d27cd0a27c?source=rss-6f7bb25e7a0c------2</link>
            <guid isPermaLink="false">https://medium.com/p/b6d27cd0a27c</guid>
            <category><![CDATA[style-guides]]></category>
            <category><![CDATA[code-review]]></category>
            <category><![CDATA[python]]></category>
            <dc:creator><![CDATA[Mo Kweon]]></dc:creator>
            <pubDate>Wed, 24 May 2017 23:42:34 GMT</pubDate>
            <atom:updated>2017-05-30T19:31:21.553Z</atom:updated>
            <content:encoded><![CDATA[<p>최근에 여러 사람들이랑 스타일가이드 얘기를 나누면서<br>또 이전에 여러 초고수분들에게 들으면서 배웠던게 생각나<br>되돌아보며 정리해볼까 해서 작성함</p><p><strong>왜 스타일 가이드인가?<br></strong>스타일 가이드는 말그대로 “가이드”일 뿐이라고 하는 사람들이 있다.<br>맞긴 맞다. 그런데 꼭 스타일대로 작성하는게 아니더라도 어느 스타일을 선택해야 된다. <strong>스타일 = 일관성</strong>이기 때문이다.</p><p>스타일이 없는 코드는 일관성이 없는 코드이며 <br>이는 가독성이 떨어지는 코드로 이어지고 흔히 얘기하는 <a href="https://en.wikipedia.org/wiki/Code_smell">코드 스멜</a>이 된다</p><p>협업을 많이 해본 사람이랑 일을 해보면<br>프로젝트의 코딩 스타일을 빠르게 알아내고 프로젝트에 완전히 녹아드는 코딩을 한다.</p><p>이외에도 코딩 스타일을 따르기보다 자기만의 스타일을 가지는 것이 좋다고 하는 사람도 만나봤는데. <a href="https://www.google.com/search?q=code+smell&amp;oq=code+smell&amp;aqs=chrome..69i57j0l5.2018j0j4&amp;sourceid=chrome&amp;ie=UTF-8#newwindow=1&amp;q=boy+scout+rule+clean+code">클린코드의 보이스카웃 룰</a>이 왜 생겼겠는가.</p><p>코드는 지금의 내가 아닌 다른 사람(미래의 나를 포함)을 위한 것이다. <br>자기만 알아보는 자기만의 스타일을 유지하는 코드는 굉장히 나쁘다. <br>완전 쓰레기로 짜놨더라도 자기는 잘 짠줄 알기 때문에 더 나쁘다. (경험자 ㅠㅠ)</p><ul><li>Explicit over Implicit</li><li>Readability over Everything</li></ul><blockquote>보이스카웃 룰이란?<br>“Always leave the campground cleaner than you found it.” 라는 말로 실제 보이스카웃 룰인데 코드를 checkout 할때마다 더 깨끗하게(?) 리팩토링후 commit을 하라는 얘기이다.</blockquote><p>갑자기 클린 코드 얘기가 나왔는데<br>클린코드와 스타일가이드는 비슷한 점이 많다.<br>둘다 서로 readability를 강조하기 때문이다.</p><p>결국 readable한 코드를 위해 코드의 일관성을 유지하는 것은 굉장히 어려운 일이고 이러한 것들을 쉽게 할 수 있게 스타일 가이드나 코딩 규약이 생기게 된 것이다.</p><p>물론 중요한 것은 스타일이 아니라 그 스타일을 따르는 “일관성”이지만, 파이썬 코드는 대부분 snake_case 함수네임과 CameCase 클래스이름등을 사용하는데 이미 대부분 오픈소스들이 특별한 이유(오래된 관습의 패키지라던지 여러 언어(C++라던지 C++라던지.. 그 C++)가 동시에 사용되는 프로젝트 등)가 없는한 이러한 규칙을 따르고 있다.</p><p>그런데 본인만 갑자기 다른 CamelCase 함수 이름을 쓴다던지 하는 경우 일관성이 깨지게 되고 다른 사람의 입장에서 from module import CamelCase 를 봤을 경우 CamelCase가 본인을 제외하고 함수인지 클래스인지 알아보기 힘들다.</p><p>결론은 특별한 이유 없으면 스타일 가이드를 따라야 한다. 아니면 적어도 일관성을 제대로 유지하도록 한다. 자기만의 스타일을 만들어 낼 정도가 되려면 다른 사람의 스타일대로 따를 수 있어야 한다.</p><p>클린코드를 작성하는 초고수분들은 자기 스스로에 대한 엄격한 잣대를 대고 있기 때문에 그 사람들의 코드는 오히려 스타일가이드보다 더 엄격하다. 하지만 비기너일수록 더더욱 스타일가이드를 따르는 훈련을 해야 한다. 심지어 따옴표 하나 스페이스 하나 하나 확인해야 스스로에게 엄격해지는 법을 배울 수 있다.</p><p>이제 여러 파이썬 스타일 가이드에 대해서 적어본다.</p><p>우선 시작하기 앞서 월급 주는 곳의 코딩규약이 물론 가장 우선시 되어야 한다. 이걸 기억하는게 좋다… 회사를 옮길때 초고수들이 코딩 컨벤션부터 먼저 확인해보는 것을 보고 감탄한 적이 있었다.</p><p><strong>1. PEP8 </strong><br><a href="https://www.python.org/dev/peps/pep-0008/">https://www.python.org/dev/peps/pep-0008/</a></p><p>파이썬 창시자 Guido van Rossum이 작성한 파이썬 스타일 가이드이다. 모든 스타일 가이드의 베이스로 깔려있다. 일단 이건 무조건 정독해야 된다. “Readability is everything”이라는 파이썬의 철학이 담겨있기 때문이다.</p><p>PEP8의 몇가지 예시들은 다음과 같다</p><ul><li>모듈의 이름은 only 소문자</li></ul><pre>(good) import modulename</pre><pre>(bad) import ModuleName<br>(bad) import module_name</pre><ul><li>클래스는 CamelCase</li></ul><pre>(good) class CamelCase(object):</pre><pre>(bad) class mixedCase(object):<br>(bad) class snake_case(object):</pre><p>참고로, class CamelCase(object) 하고 class CamelCase:는 다르다. 아니 달랐다. 전자가 new style 이고 후자가 old style인데 Python3에서는 old style이 없어졌다. (써도 전자 처럼 되지만 조금 달라서 전자로 explicit한 것이 좋음)</p><ul><li>함수의 이름은 snake_case</li></ul><pre>(good) def python_function_name(arg1, arg2):</pre><pre>(bad) def PythonFunctionName(arg1, arg2):<br>(bad) def pythonFunctionName(arg1, arg2):</pre><ul><li>들여쓰기는 스페이스 4칸</li></ul><p>더 자세한건 <a href="https://www.python.org/dev/peps/pep-0008/">공홈</a>에서 확인해 볼 수 있다</p><p><strong>2. Google Python Style Guide</strong><br><a href="https://google.github.io/styleguide/pyguide.html">https://google.github.io/styleguide/pyguide.html</a></p><ul><li>PEP8과 거의 유사하다.</li><li>구글 프로젝트 (Tensorflow) 때문에 가장 요즘 많이 접하게 된다.</li><li>PEP8과 비교해서 가장 다른 점은 “Docstring”을 작성하는 법에 대해 좀더 깊이 다루고 있다.</li></ul><p>예를 들면,</p><pre>def add_two_numbers(number1, number2):<br>    return number1 + number2</pre><p>라는 함수가 있으면 아래와 같이 docstring을 작성한다.</p><pre>def add_two_numbers(number1, number2):<br>    &quot;&quot;&quot;Returns the sum of two numbers</pre><pre>    Args:<br>        number1 (int): First number to add<br>        number2 (int): Second number to add</pre><pre>    Returns:<br>        int: Sum of `number1` and `number2`<br>   &quot;&quot;&quot;</pre><p>구글의 Docstring style은 보자마자, 무슨 타입의 인풋을 넣어줘야 되는 지, 결과값이 어떤 타입인지 바로 알 수 있다.</p><p>코딩 코멘트의 경우 가장 좋은 코멘트는 죽은 코멘트…즉 코멘트를 작성하지 않고 Self Explanatory 한 코드를 작성하는 것이지만, Docstring은 코멘트와 달리 툴팁에 나오는 부분이기 때문에 거진 필수적으로 적어줘야 한다.</p><p>아래 예제를 보자.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/db22fbb28464b75bbd37fb6fe5f808d3/href">https://medium.com/media/db22fbb28464b75bbd37fb6fe5f808d3/href</a></iframe><p>많이 본 사람들은 제외하면 이게 어떤 식으로 동작하는지 <br>여기서 r 과 gamma는 도대체 무슨 값인지 알기 어렵다.</p><p>다시 docstring과 함께 보면,</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/7132533af312a55bd88797656ed1e9b4/href">https://medium.com/media/7132533af312a55bd88797656ed1e9b4/href</a></iframe><p>코드를 보지 않아도 Example 과 Docstring 으로 <br>충분히 다음과 같은 정보를 알 수 있다.</p><ul><li>무슨 일을 하는 함수인가? <br>- discounted rewards를 구하는 함수</li><li>인풋은 무엇을 받는가? <br>- (?,) shape의 np.ndarray <br>- float type의 gamma</li><li>결과값은 무엇인가?<br>- (?,) shape 의 np.ndarray 인 것을 알 수 있다.</li></ul><p>이 외에도 스타일을 따르면 좋은 점은 텐서플로우 공식홈페이지 같은 api guide 문서도 doxygen이나 스핑크스 등을 통해 저절로 만들어진다. api 가이드 문서 작업 일을 미리 한다고 생각하면 된다.</p><p>아래 두개의 docstring을 어떻게 작성해야 되는지 여기서 다 언급할 수는 없지만 알아두는 것이 좋다.</p><ul><li>함수의 Docstring</li><li>Class의 Docstring</li></ul><p><strong>3. Numpy/Scipy Style Guide<br></strong><a href="https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt">https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt</a></p><ul><li>PEP8을 베이스로 한다</li><li>구글과 마찬가지로 Docstring만 거의 다르다</li></ul><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/0343bb990a9782eb656594c4810366f6/href">https://medium.com/media/0343bb990a9782eb656594c4810366f6/href</a></iframe><p>Numpy 좀 쓰셨다 싶으신 분들은 많이 눈에 익을 것이다.<br>매우 가독성에 초점을 맞춘 Docstring이고 덕분에 Numpy가 이렇게 널리 퍼질 수 있는 이유 중에 하나라고 생각한다. Numpy가 쉬운게 아니라 Docstring이 정말 잘 되있다.</p><p>원래 가장 선호했던 스타일이기도 하다. 스핑크스랑도 잘 붙기 때문에…</p><p>많은 Science Library들이 Numpy의 영향을 많이 받았기 때문에 Science Library에서 가장 많이 사용되는 스타일이다.</p><p>여기 나온 것 뿐만 아니라 lint에 대해서도 알면 좋지만 글이 길어져 이만 줄인다.<br>짧게 쓰면 아래 세개는 다 사용할 줄 알아야 한다.</p><ul><li><a href="https://www.pylint.org/">pylint</a></li><li><a href="https://github.com/hhatto/autopep8">autopep8</a></li><li><a href="https://github.com/myint/autoflake">autoflake</a></li></ul><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=b6d27cd0a27c" width="1" height="1" alt="">]]></content:encoded>
        </item>
    </channel>
</rss>