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

Docs: update plot_butterfly docs #119

Merged
merged 3 commits into from
Nov 28, 2023
Merged

Docs: update plot_butterfly docs #119

merged 3 commits into from
Nov 28, 2023

Conversation

behinger
Copy link
Member

No description provided.

Copy link

codecov bot commented Nov 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (23de34e) 84.28% compared to head (a49acef) 84.28%.
Report is 28 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #119   +/-   ##
=======================================
  Coverage   84.28%   84.28%           
=======================================
  Files          17       17           
  Lines         611      611           
=======================================
  Hits          515      515           
  Misses         96       96           

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

Copy link
Collaborator

@vladdez vladdez left a comment

Choose a reason for hiding this comment

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

  1. Should be:
    "provide 2D layout positions to add an inset based on channel location and color the lines in a logical way."
    Lowercase and comma at the end.
    But I would write: "add an inset with channel layout with colors corresponding with lines.".
  2. what the difference between? Are they both change erp plot to butterfly plot? What "Internal" means?
  • positions (nothing): see plot_butterfly.
    Internal:
  • butterfly (bool, true): a butterfly plot.
  1. As is understood "positions" add topoplot, Why not to call it "add_topoplot" or "add_layout"? Otherwise it is not obvious what this arguments does.

@behinger
Copy link
Member Author

  1. I rephrased it again.
  2. I dont understand your comment. can you rephrase?
  3. topolegend already exists which is exactly what you propose. But you might want to have position-wise colors, but not the topoinset, so both are neede

added more consistency, couple of dots and removed a repetition. 
And "positions" should be Array not nothing, right?
@behinger behinger merged commit 6599355 into main Nov 28, 2023
4 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