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

Docstring for VSCode preview #1823

Open
stefan-balke opened this issue Mar 26, 2024 · 1 comment
Open

Docstring for VSCode preview #1823

stefan-balke opened this issue Mar 26, 2024 · 1 comment
Labels
documentation Issues relating to docstrings, examples, and documentation build

Comments

@stefan-balke
Copy link
Member

Hi,

I just stumbled on the Docstring preview in VSCode and that numpy's version is much nicer whereas librosa only shows the TOC.

Seems that VSCode simply renders the Docstring given in the __init__.py.
https://github.com/librosa/librosa/blob/main/librosa/__init__.py

It could simply be a copy-pasta from the docs starting page stating what librosa is about.

image
image
@bmcfee bmcfee added the documentation Issues relating to docstrings, examples, and documentation build label Mar 28, 2024
@bmcfee
Copy link
Member

bmcfee commented Mar 28, 2024

Maybe relevant to #1801

@bmcfee bmcfee mentioned this issue Apr 4, 2024
Open
9 tasks
@bmcfee bmcfee added this to the 0.10.2 milestone Apr 5, 2024
@bmcfee bmcfee removed this from the 0.10.2 milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Issues relating to docstrings, examples, and documentation build
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bmcfee @stefan-balke