question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Spyder doesn't show complete object documentation.

See original GitHub issue

Description of your problem

I am trying to get documentation of some objects by pressing cmd+I in spyder but it gives a one line definition of the object instead of a detailed one. I am using python 3.5 and spyder 3.1.4. For e.g. documentation for OLS object looks like What steps will reproduce the problem?

  1. Type name of any class object
  2. Press Cmd+I
  3. Look for documentation in Help

What is the expected output? What do you see instead? Expected a full documentation about the object. Got a one line documentation describing what the object does. No mention of parameters etc.

Please provide any additional information below It looks like screen shot 2017-07-22 at 1 24 39 pm

but should look like this(image from an online video) screen shot 2017-07-22 at 1 25 28 pm

Versions and main components

  • Spyder Version: 3.1.4
  • Python Version: 3.5
  • Qt Version: 5.6.2
  • PyQt Version: 5.6
  • Operating system: macOS 10.12.6

Dependencies

Please go to the menu entry Help > Optional Dependencies (or Help > Dependencies), press the button Copy to clipboard and paste the contents below:

jedi >=0.9.0 : 0.9.0 (OK) matplotlib >=1.0 : 2.0.0 (OK) nbconvert >=4.0 : 4.2.0 (OK) numpy >=1.7 : 1.11.3 (OK) pandas >=0.13.1 : 0.19.2 (OK) pep8 >=0.6 : 1.7.0 (OK) psutil >=0.3 : 5.0.1 (OK) pyflakes >=0.6.0 : 1.5.0 (OK) pygments >=2.0 : 2.1.3 (OK) pylint >=0.25 : 1.6.4 (OK) qtconsole >=4.2.0: 4.3.0 (OK) rope >=0.9.4 : 0.9.4-1 (OK) sphinx >=0.6.6 : 1.5.1 (OK) sympy >=0.7.3 : 1.0 (OK)

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
Prikerscommented, Jul 23, 2017

Is this because OLS uses __doc__ rather than the “triple quote” docstring ("""...""") for the class definition? Anytime it uses __doc__, trying to get the documentation from Cmd+I brings the problem. For instance:

from statsmodels.regression.linear_model import OLS
OLS() # Cmd + I on this --> problem (OLS uses __doc__) 
OLS.score() # Cmd + I on this --> no problem (OLS.score uses triple quote docstring)

From the console OLS? brings the full documentation though.

0reactions
bcolsencommented, Apr 8, 2019

Duplicate of #5522

Read more comments on GitHub >

github_iconTop Results From Across the Web

Spyder not showing complete documentation [closed]
Anytime it uses doc, trying to get the documentation from Cmd+I brings the problem. For instance: from statsmodels.regression.linear_model ...
Read more >
Help — Spyder 5 documentation
You can use the Help pane to find, render and display rich documentation for any object with a docstring, including modules, classes, functions...
Read more >
Spyder - the Python IDE — Computational Science and Data ...
When we execute the whole program (by pressing F5), Python goes through the file, creates the hello function object (overriding the previous ...
Read more >
Basic Syntax | CADS | Farmer School of Business
Change syntax color to Spyder/Dark under Editor in Preferences ... You can enable the object inspector to display the documentation of a function...
Read more >
Troubleshooting — Anaconda documentation
Use `conda config --show channels` to view your configuration's current state, ... Cause¶. Anaconda 5.0.1 sometimes does not install completely on Windows.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found