{
  "version": "https://jsonfeed.org/version/1.1",
  "title": "chem-bla-ics",
  "description": "Chemblaics (pronounced chem-bla-ics) is the science that uses open science and computers to solve problems in chemistry, biochemistry and related fields.",
  "home_page_url": "https://chem-bla-ics.linkedchemistry.info/",
  "feed_url": "https://chem-bla-ics.linkedchemistry.info/2008/12/04/short-variables-and-lack-of-comments.json",
  "icon": "https://chem-bla-ics.linkedchemistry.info/assets/images/chem-bla-ics_logo.png",
  "language": "en",
  "authors": [
    {
      "name": "Egon Willighagen",
      "url": "https://orcid.org/0000-0001-7542-0286",
      "_orcid": "0000-0001-7542-0286"
    }
  ],
  "items": [

    {
      "id": "https://doi.org/10.59350/56vn2-zgc48",
      "url": "https://chem-bla-ics.linkedchemistry.info/2008/12/04/short-variables-and-lack-of-comments.html",
      "title": "Short variables and lack of comments...",
      "content_html": "<p>… a source code reviewer nightmare. The must-read <a href=\"http://www.lwn.net/\">lwn.net</a> ran a <a href=\"http://lwn.net/Articles/308566/\">nice open letter</a>\nto a Linux kernel developer. I’d like to cite this bit about code review (see also <a href=\"https://chem-bla-ics.linkedchemistry.info/2008/11/12/re-open-source-peer-review.html\">Re: Open Source != peer review <i class=\"fa-solid fa-recycle fa-xs\"></i></a>):</p>\n\n<blockquote>\n  <p>[Andrew Morton] had a number of concrete requests - such as documenting the user-space ABI and the network protocol - which have not been\nsatisfied. He also asked for better code documentation in general:</p>\n\n  <ul>\n  So please. Go through all the code and make it tell a story. Ask yourself \"how would I explain all this to a kernel developer who is sitting next to me\".\n  It's important, and it's an important skill.\n</ul>\n</blockquote>\n\n<p>This is important indeed! This is also why CDK quality assurance tends to complain about short variables. While an for-next index <code class=\"language-plaintext highlighter-rouge\">i</code> is clear enough, <code class=\"language-plaintext highlighter-rouge\">ac</code> for an\n<code class=\"language-plaintext highlighter-rouge\">IAtomContainer</code> is quite useless, as it does not explain what the purpose of the container is. BTW, a longer name like <code class=\"language-plaintext highlighter-rouge\">atomContainer</code>\ndoes not really help here. Maybe I will wrote a unit test for that…</p>",
      "summary": "… a source code reviewer nightmare. The must-read lwn.net ran a nice open letter to a Linux kernel developer. I’d like to cite this bit about code review (see also Re: Open Source != peer review ):",
      
      "date_published": "2008-12-04T00:00:00+00:00",
      "date_modified": "2025-10-11T00:00:00+00:00",
      
      
      
      
      
      
      
        "authors": [ { "name": "Egon Willighagen", "url": "https://orcid.org/0000-0001-7542-0286" } ]
      
    }

  ]
}