Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Object Inspector is not showing "No documentation available" for objects without docstring #2234

Closed
ccordoba12 opened this issue Mar 11, 2015 · 4 comments · Fixed by #2242
Closed

Object Inspector is not showing "No documentation available" for objects without docstring #2234

ccordoba12 opened this issue Mar 11, 2015 · 4 comments · Fixed by #2242
Assignees
@blink1073
Labels
component:Help
Milestone
v2.3.4

Comments

@ccordoba12
Copy link
Member

It seems Jedi returns <no docstring> instead of an empty string for objects without docstring. This prevents the Object Inspector to show the No documentation available warning page.
@ccordoba12 ccordoba12 added this to the v2.3.4 milestone Mar 11, 2015
@ccordoba12
Copy link
Member Author

@blink1073, can you take a look at it?

@blink1073
Copy link
Contributor

Here's what I see (which was part of my last PR on Bitbucket), which I think is preferable since it at least shows some information about the function.

screenshot from 2015-03-13 08 35 55

@Nodd
Copy link
Contributor

Nodd commented Mar 13, 2015

Maybe No documentation available. would be better than <no docstring> which looks too computer-y. A full sentence (even without a verb) is nicer than an html opening tag...

@blink1073
Copy link
Contributor

<fine>

@blink1073 blink1073 mentioned this issue Mar 13, 2015
Merged
@ccordoba12 ccordoba12 changed the title Jedi is not showing "No documentation available" for objects without docstring Object Inspector is not showing "No documentation available" for objects without docstring Mar 16, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@blink1073 blink1073

Labels
component:Help
Projects
None yet
Milestone
v2.3.4
Development

Successfully merging a pull request may close this issue.

Improve message for no docstring blink1073/spyder
3 participants
@ccordoba12 @Nodd @blink1073