title: Documenting Python parameters in docstring using PyCharm
body: <p>I'm having some trouble figuring out the proper way to document a method in Pycharm to achieve type hints AND parameter description.</p>
  
  <p>In <a href="https://www.jetbrains.com/pycharm/help/type-hinting-in-pycharm.html" rel="noreferrer">Pycharm's documentation</a> it suggests: </p>
  
  <blockquote>
    <p>:param "type_name" "param_name": "param_description"</p>
  </blockquote>
  
  <p>(1) However, when I try to use that, the function definition does not properly show the parameter description:</p>
  
  <p><a href="https://i.stack.imgur.com/OSeRP.png" rel="noreferrer"><img src="https://i.stack.imgur.com/OSeRP.png" alt="enter image description here"></a></p>
  
  <p>(2) If I switch to leading with the <code>@</code> sign I get a list of parameters and their types, but I do not get the parameter description:</p>
  
  <p><a href="https://i.stack.imgur.com/C3lst.png" rel="noreferrer"><img src="https://i.stack.imgur.com/C3lst.png" alt="enter image description here"></a></p>
  
  <p>(3) If I stick with the <code>@</code> sign and drop the types, I get the parameter descriptions:</p>
  
  <p><a href="https://i.stack.imgur.com/0Kc6e.png" rel="noreferrer"><img src="https://i.stack.imgur.com/0Kc6e.png" alt="enter image description here"></a></p>
  
  <p>(4) If I explicitly add <code>@type</code> for each <code>@param</code> (which completely blows up the size of the comment block), everything works properly (but I hate the size of the comment):</p>
  
  <p><a href="https://i.stack.imgur.com/n2zYg.png" rel="noreferrer"><img src="https://i.stack.imgur.com/n2zYg.png" alt="enter image description here"></a></p>
  
  <p>(5) Finally, for sake of completeness, using <code>:</code> instead of <code>@</code> causes everything to fail to populate:</p>
  
  <p><a href="https://i.stack.imgur.com/i6PBt.png" rel="noreferrer"><img src="https://i.stack.imgur.com/i6PBt.png" alt="enter image description here"></a></p>
  
  <p>Note that I have tried changing the documentation system within Pycharm, but it doesn't affect how it renders the documentation -- it only seems to affect how it autopopulates a comment block for you.</p>
  
  <p>How can I achieve documentation as close to example (1) which is compact, but actually have it populate the function definition properly?  I'd hate to be stuck with style (4).</p>