spyder-ide / spyder

Official repository for Spyder - The Scientific Python Development Environment
https://www.spyder-ide.org
MIT License
8.3k stars 1.61k forks source link

No further documentation in editor #20026

Open realseqi opened 1 year ago

realseqi commented 1 year ago

Problem Description

I can't use documentation in the editor but it works fine in the IPython console. I came across this issue in spyder 5.3.3, and the issue continues in 5.4.0

What steps reproduce the problem?

When pressing Control+I or hoover around the function it shows no further documentation. For example, for function pd.merge(), no further documentation in the editor but the documentation popped out when pressing Control+I in the console.

What is the expected output? What do you see instead?

Versions

Dependencies

# Mandatory:
atomicwrites >=1.2.0          :  1.4.1 (OK)
chardet >=2.0.0               :  5.0.0 (OK)
cloudpickle >=0.5.0           :  2.2.0 (OK)
cookiecutter >=1.6.0          :  2.1.1 (OK)
diff_match_patch >=20181111   :  20200713 (OK)
intervaltree >=3.0.2          :  3.1.0 (OK)
IPython >=7.31.1;<8.0.0       :  7.33.0 (OK)
jedi >=0.17.2;<0.19.0         :  0.18.1 (OK)
jellyfish >=0.7               :  0.9.0 (OK)
jsonschema >=3.2.0            :  4.16.0 (OK)
keyring >=17.0.0              :  23.9.3 (OK)
nbconvert >=4.0               :  7.2.1 (OK)
numpydoc >=0.6.0              :  1.5.0 (OK)
paramiko >=2.4.0              :  2.11.0 (OK)
parso >=0.7.0;<0.9.0          :  0.8.3 (OK)
pexpect >=4.4.0               :  4.8.0 (OK)
pickleshare >=0.4             :  0.7.5 (OK)
psutil >=5.3                  :  5.9.2 (OK)
pygments >=2.0                :  2.13.0 (OK)
pylint >=2.5.0;<3.0           :  2.15.3 (OK)
pylint_venv >=2.1.1           :  2.3.0 (OK)
pyls_spyder >=0.4.0           :  0.4.0 (OK)
pylsp >=1.6.0;<1.7.0          :  1.6.0 (OK)
pylsp_black >=1.2.0           :  1.2.1 (OK)
qdarkstyle >=3.0.2;<3.1.0     :  3.0.3 (OK)
qstylizer >=0.2.2             :  0.2.2 (OK)
qtawesome >=1.2.1             :  1.2.1 (OK)
qtconsole >=5.4.0;<5.5.0      :  5.4.0 (OK)
qtpy >=2.1.0                  :  2.2.1 (OK)
rtree >=0.9.7                 :  1.0.0 (OK)
setuptools >=49.6.0           :  65.4.1 (OK)
sphinx >=0.6.6                :  5.2.3 (OK)
spyder_kernels >=2.4.0;<2.5.0 :  2.4.0 (OK)
textdistance >=4.2.0          :  4.5.0 (OK)
three_merge >=0.1.1           :  0.1.1 (OK)
watchdog >=0.10.3             :  2.1.9 (OK)
zmq >=22.1.0                  :  24.0.1 (OK)

# Optional:
cython >=0.21                 :  None (NOK)
matplotlib >=3.0.0            :  3.6.0 (OK)
numpy >=1.7                   :  1.23.3 (OK)
pandas >=1.1.1                :  1.5.0 (OK)
scipy >=0.17.0                :  1.9.1 (OK)
sympy >=0.7.3                 :  None (NOK)
ccordoba12 commented 1 year ago

Hey @realseqi, thanks for reporting. This is a know issue but we have plans to improve it in Spyder 6.

Just so we know when we try to fix this, I'd like to ask you: what's the Python module or modules you're unable to get docs for in the editor?

ccordoba12 commented 1 year ago

Sorry, I just saw that you mentioned pd.merge as the method giving you troubles.

realseqi commented 1 year ago

Sorry, I just saw that you mentioned pd.merge as the method giving you troubles.

Hi @ccordoba12 ,yes, basically no documentation for all pandas function in the editor. Good to know the issue will be fixed in Spyder 6.

ccordoba12 commented 1 year ago

Ok, we'll improve the situation for Pandas and Matplotlib in our next version (5.4.1) and will provide a mechanism for users to pass other modules to it in Spyder 6.