8000 Add docstrings to indicators by MarcSkovMadsen · Pull Request #3359 · holoviz/panel · GitHub
[go: up one dir, main page]
Skip to content

Add docstrings to indicators #3359

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
Merged
philippjfr merged 4 commits into from
Apr 10, 2022
Merged

Add docstrings to indicators #3359

philippjfr merged 4 commits into from
Apr 10, 2022

8000 Conversation

@MarcSkovMadsen
Copy link
Collaborator
@MarcSkovMadsen MarcSkovMadsen commented Apr 10, 2022

The docstrings make it so much easier to use the widgets in an IDE like VS Code.

image

@codecov
Copy link
codecov bot commented Apr 10, 2022 •
edited
Loading

Codecov Report

Merging #3359 (4d85435) into master (4d4afb7) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 4d85435 differs from pull request most recent head 37b7693. Consider uploading reports for the commit 37b7693 to get more accurate results

@@           Coverage Diff           @@
##           master    #3359   +/-   ##
=======================================
  Coverage   83.27%   83.27%           
=======================================
  Files         196      196           
  Lines       26607    26607           
=======================================
  Hits        22156    22156           
  Misses       4451     4451
Impacted Files Coverage Δ
panel/widgets/indicators.py 92.48% <100.00%> (ø)

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 4d4afb7...37b7693. Read the comment docs.

@philippjfr philippjfr merged commit 3179c1b into master Apr 10, 2022
@philippjfr philippjfr deleted the indicator-docstrings branch April 10, 2022 09:52
@MarcSkovMadsen
Copy link
Collaborator Author
MarcSkovMadsen commented Apr 11, 2022

Thanks for wrapping the docstrings @philippjfr . Could you enlighten me why you do it? (I would like to know such that you don't have to do it).

I normally work with a max -line-length of 100 and I can see Panels flake8 rule is 165

image

@github-actions
Copy link
github-actions bot commented Sep 11, 2025

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@philippjfr philippjfr Awaiting requested review from philippjfr

Assignees

No one assigned

Labels

ready for review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MarcSkovMadsen @philippjfr
0