restructuredText Quick Documentation Display

It appears that versions of PyCharm after 2018.1.6 display restructuredText documentation differently. This is what restructredText documentation looked like in version 2018.1.6:

Notice that each parameter is followed by the type in brackets and each type is a clickable link that allows you to view the documentation for that type.

This is what the documentation looks like in versions after 2018.1.6:

Notice that the parameter names are no longer followed by the type in brackets. It is still possible to view documentation about the types if you click on the type in the function prototype above the documentation but it does not support types that are nested in a module or a class anymore.

I have tested this on the following versions of PyCharm:

  • 2020.1
  • 2019.3.4
  • 2019.2.6
  • 2019.1.4
  • 2018.3.7
  • 2018.2.8

All of the above versions display restructuredText as show in the second image so I have to ask, is this an expected change? If so, is there a new way I can type my docstrings such that items like the nested class in my example code show up with a clickable link at the top of the documentation at the very least?

Any help is greatly appreciated!

1

Please sign in to leave a comment.