Skip to content

Conversation

@tluebeck
Copy link

@tluebeck tluebeck commented Jun 3, 2025

Which issue(s) are closed by this pull request?

Closes #

Changes proposed in this pull request:

  • added SphericalHarmonicSignal to documentation, similar to pyfar style
  • added introduction to SpamplingSphere documentation page
  • we need to wait for Add Spherical Harmonics class #101 to add a general documentation of the Spherical Harmonics implementation

@ahms5
Copy link
Member

ahms5 commented Jun 3, 2025

maybe we can also discuss if we want to have it on one doc page or each class on separated doc pages.

@ahms5 ahms5 added this to the v1.0.0 milestone Jun 3, 2025
@ahms5 ahms5 moved this from Backlog to Open Discussion in Weekly Planning Jun 3, 2025
@ahms5 ahms5 added the documentation Improvements or additions to documentation label Jun 3, 2025
@f-brinkmann
Copy link
Member

@tluebeck I opened #152 would suggest the following after merging this:

  • Lets make an entry 'Spherical Harmonic' under the Classes section of the docs
  • This entry contains the SphericalHarmonic class and the SHSignal
  • Move the general documentation that is now in the SphericalHarmonic class to the top of the docs page
  • add information which combinations of parameters result in poular SH conventions (AmbiX, Willians/Rafely, Arend/Spors, SOFA, MPEG)

@tluebeck
Copy link
Author

As discussed in #160 we can consider moving SHSignal to classes.sh as well and include the documentation at the top of that file. Let's discuss tomorrow.

@tluebeck tluebeck marked this pull request as ready for review July 1, 2025 13:29
@tluebeck tluebeck requested review from ahms5, f-brinkmann, mberz and xefonon and removed request for ahms5 and xefonon July 3, 2025 05:49
@mberz
Copy link
Member

mberz commented Jul 3, 2025

Please remove the _build directory from git ;)

@f-brinkmann f-brinkmann modified the milestones: v1.0.0, v1.1.0 Sep 12, 2025
@ahms5
Copy link
Member

ahms5 commented Sep 12, 2025

this pr is partially v1.0.0 and v1.1.0 we need to fix it somehow @mberz @tluebeck

@f-brinkmann
Copy link
Member

this pr is partially v1.0.0 and v1.1.0 we need to fix it somehow @mberz @tluebeck

Also see #176

@sikersten
Copy link
Member

Also relevant for #173

@mberz
Copy link
Member

mberz commented Sep 22, 2025

Since this PR tries to do too many things at once (and also does not agree with the new release schedule), I'll split it up into smaller PRs over the next days and subsequently close here.
For this reason I'm moving this PR to "on hold" and revoke all reviews and assignees.

@mberz mberz moved this from Open Discussion to On hold in Weekly Planning Sep 22, 2025
@mberz mberz added the wontfix This will not be worked on label Sep 22, 2025
@mberz mberz changed the title add SHSignal to docs [On Hold] add SHSignal to docs Sep 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation wontfix This will not be worked on

Projects

Status: On hold

Development

Successfully merging this pull request may close these issues.

6 participants