[ENH] Add avg_method to plot_surf_stat_map

[Remi-Gau]

• Related to [BUG] avg_method and symmetric_cbar flags using plot_surf_stat_map working properly with plotly engine #4296

Changes proposed in this pull request:

• add avg_method parameter to plot_surf_stat_map
• throw warnings when using plotly and passing an unimplemented parameter to one of the surface plotting function to avoid users being confused why some parameters have no effect.
  • this required setting the default of a few parameters to None in the function declaration and using the original default when using the matplotlib engine.
  • this should now be reflected in the doc strings

[github-actions]

👋 @Remi-Gau Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

• PR has an interpretable title.
• PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
• Code is PEP8-compliant (see our documentation on coding style)
• Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

• There is at least one unit test per new function / class (see our documentation on testing)
• The new feature is demoed in at least one relevant example.

For bug fixes:

• There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.13%. Comparing base (abb80ff) to head (e4624ac).
Report is 23 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4298      +/-   ##
==========================================
+ Coverage   91.85%   92.13%   +0.27%     
==========================================
  Files         144      143       -1     
  Lines       16419    16452      +33     
  Branches     3434     3451      +17     
==========================================
+ Hits        15082    15158      +76     
+ Misses        792      749      -43     
  Partials      545      545              

Flag	Coverage Δ
macos-latest_3.10_test_plotting	91.92% <100.00%> (?)
macos-latest_3.11_test_plotting	?
macos-latest_3.12_test_plotting	91.92% <100.00%> (?)
macos-latest_3.8_test_plotting	91.88% <100.00%> (?)
macos-latest_3.9_test_plotting	91.89% <100.00%> (?)
ubuntu-latest_3.10_test_plotting	91.92% <100.00%> (+0.07%)	⬆️
ubuntu-latest_3.11_test_plotting	91.92% <100.00%> (?)
ubuntu-latest_3.12_test_plotting	91.92% <100.00%> (?)
ubuntu-latest_3.12_test_pre	91.92% <100.00%> (?)
ubuntu-latest_3.8_test_min	68.81% <0.00%> (?)
ubuntu-latest_3.8_test_plot_min	91.59% <42.85%> (?)
ubuntu-latest_3.8_test_plotting	91.88% <100.00%> (?)
ubuntu-latest_3.9_test_plotting	91.89% <100.00%> (?)
windows-latest_3.10_test_plotting	91.90% <100.00%> (?)
windows-latest_3.11_test_plotting	91.90% <100.00%> (?)
windows-latest_3.12_test_plotting	91.90% <100.00%> (?)
windows-latest_3.8_test_plotting	91.86% <100.00%> (?)
windows-latest_3.9_test_plotting	91.87% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[Remi-Gau]

@bthirion
Am not sure we can consider this PR as bug fix. What do you think?
If not a bug fix, am tempted to say we wait to merge this.

[bthirion]

LGTM overall, thx !

[bthirion]

So, why not keeping auto as a default ?

[Remi-Gau]

Let me specify this to say this will happen only when using the matplotlib engine.

[bthirion]

The change LGTM, thx.