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

Update plotting docstrings #247

Merged
merged 4 commits into from
Feb 6, 2025
Merged

Update plotting docstrings #247

merged 4 commits into from
Feb 6, 2025

Conversation

leburgel
Copy link
Member

@leburgel leburgel commented Feb 6, 2025

Updates the plotting docstrings to state that users need to add using Plots themselves before being able to produce any plots.

See #246.

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
src/utility/plotting.jl 86.36% <100.00%> (ø)

... and 2 files with indirect coverage changes

Copy link
Member

@lkdvos lkdvos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to make a slightly more clear separation between arguments and keyword arguments? With them listed like this, you need to have noticed that there is a semicolon in the signature, which seems a bit easy to miss

@leburgel
Copy link
Member Author

leburgel commented Feb 6, 2025

Would it be possible to make a slightly more clear separation between arguments and keyword arguments?

Done, and also updated the signature itself (the transferplot one didn't even have the semicolon...).

@leburgel leburgel merged commit 550165d into master Feb 6, 2025
28 checks passed
@leburgel leburgel deleted the lb/plots_warning branch February 6, 2025 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants