https://raveenkumar.com/tags/documentation/ Recent content in Documentation on Raveen Kumar Hugo en-US Raveen Kumar Tue, 28 Feb 2023 00:00:00 +0000 https://raveenkumar.com/posts/2023-02-28-python-docstrings/ Tue, 28 Feb 2023 00:00:00 +0000 https://raveenkumar.com/posts/2023-02-28-python-docstrings/ <p>In python, docstrings are used to define the functions documentation. Refer this page,</p> <p><a href="https://peps.python.org/pep-0257/">https://peps.python.org/pep-0257/</a></p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-python" data-lang="python"><span style="display:flex;"><span> </span></span><span style="display:flex;"><span><span style="color:#66d9ef">def</span> <span style="color:#a6e22e">function</span>(a, b): </span></span><span style="display:flex;"><span> <span style="color:#e6db74">&#34;&#34;&#34;Do X and return a list.&#34;&#34;&#34;</span> </span></span><span style="display:flex;"><span> </span></span></code></pre></div> https://raveenkumar.com/library/programming/documentation/ Fri, 17 Feb 2023 00:00:00 +0000 https://raveenkumar.com/library/programming/documentation/ <ul> <li><a href="https://documentation.divio.com/">https://documentation.divio.com/</a></li> <li><a href="https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community">Documentation as a way to build community</a></li> </ul>