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.

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

Adds the remaining widget docstrings #3367

Merged
merged 13 commits into from
Apr 12, 2022
Merged

Conversation

MarcSkovMadsen
Copy link
Collaborator

Adds the remaining widget docstrings and also docstrings to the panel and widgets modules.

The purpose is to make it much easier to navigate the code in a modern IDE like VS Code or PyCharm

@MarcSkovMadsen
Copy link
Collaborator Author

Why do you add the noqa below @philippjfr?

I have a feeling it is what hinders tooltips for pn.widgets to show up in VS Code??

image

@codecov
Copy link

codecov bot commented Apr 12, 2022

Codecov Report

Merging #3367 (e87d1ee) into master (3504e87) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3367      +/-   ##
==========================================
+ Coverage   83.33%   83.34%   +0.01%     
==========================================
  Files         198      198              
  Lines       26791    26791              
==========================================
+ Hits        22327    22330       +3     
+ Misses       4464     4461       -3     
Impacted Files Coverage Δ
panel/__init__.py 100.00% <ø> (ø)
panel/widgets/__init__.py 100.00% <ø> (ø)
panel/widgets/speech_to_text.py 78.76% <ø> (ø)
panel/widgets/tables.py 88.20% <ø> (ø)
panel/widgets/terminal.py 72.03% <ø> (ø)
panel/widgets/text_to_speech.py 85.18% <ø> (ø)
panel/widgets/texteditor.py 100.00% <ø> (ø)
panel/io/server.py 78.30% <0.00%> (+0.21%) ⬆️
panel/io/reload.py 71.73% <0.00%> (+2.17%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3504e87...e87d1ee. Read the comment docs.

@jbednar
Copy link
Member

jbednar commented Apr 12, 2022

Usuallynoqa will be added if we have an import provided for API purposes, to avoid having linters complain about unused imports.

@philippjfr philippjfr merged commit 5eb3140 into master Apr 12, 2022
@philippjfr philippjfr deleted the rest-widgets-docstrings branch April 12, 2022 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants