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

Add 'lineshuffle' command #715

Merged
merged 4 commits into from
Apr 9, 2024
Merged

Add 'lineshuffle' command #715

merged 4 commits into from
Apr 9, 2024

Conversation

gatesphere
Copy link
Contributor

Description

Adds a 'lineshuffle' layer processor to randomize the plotting order of lines in the current geometry. Useful in some niche cases where a plotting-time optimized file is not ideal.

Checklist

  • feature/fix implemented
  • code formatting ok (black and ruff check .)
  • mypy returns no error
  • tests added/updated and pytest succeeds
  • documentation added/updated
    • command docstring and option/argument help
    • README.md updated (Feature Overview)
    • CHANGELOG.md updated
    • added new command to reference.rst
    • RTD doc updated and building with no error (make clean && make html in docs/)

@gatesphere gatesphere mentioned this pull request Apr 5, 2024
10 tasks
@gatesphere
Copy link
Contributor Author

Quality Gate Failed Quality Gate failed

Failed conditions 1 Security Hotspot

See analysis details on SonarCloud

This use of random.shuffle is not in proximity of any cryptographically sensitive code.

docs/conf.py Outdated
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was changed by 'ruff check --fix', not something I did manually.

Copy link
Owner

Choose a reason for hiding this comment

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

ok, whatever :)

Copy link

codecov bot commented Apr 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.69%. Comparing base (9c9de12) to head (e105967).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #715   +/-   ##
=======================================
  Coverage   94.68%   94.69%           
=======================================
  Files          62       62           
  Lines        5777     5783    +6     
  Branches     1275     1278    +3     
=======================================
+ Hits         5470     5476    +6     
  Misses        189      189           
  Partials      118      118           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Owner

@abey79 abey79 left a comment

Choose a reason for hiding this comment

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

Nice addition! I've actually been wanting it multiple times before. Everything looks good, except for that symlink situation that needs to be reverted, and that extra test that can probably go.

docs/conf.py Outdated
Copy link
Owner

Choose a reason for hiding this comment

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

ok, whatever :)

docs/CHANGELOG.md Outdated Show resolved Hide resolved
tests/test_commands.py Outdated Show resolved Hide resolved
@gatesphere gatesphere requested a review from abey79 April 6, 2024 00:37
Copy link

sonarqubecloud bot commented Apr 6, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@abey79
Copy link
Owner

abey79 commented Apr 6, 2024

I simplified a bit the doc string, and realised that I could also significantly simplify the code :)

@abey79 abey79 merged commit 9fd17d5 into abey79:master Apr 9, 2024
14 checks passed
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