Skip to content

Docs v1 refactoring #150

Merged
mberz merged 9 commits intodevelopfrom
docs/v1_refactoring
Mar 19, 2026
Merged

Docs v1 refactoring #150
mberz merged 9 commits intodevelopfrom
docs/v1_refactoring

Conversation

@SimonBuechner
Copy link
Contributor

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

Closes #140 #145

Changes proposed in this pull request:

  • Proposed docstring changes from WIP: Docs/docstring refactoring #140 adjusted to new package structure
  • Additonal description in schroeder_integration for usability. This includes a note about neccessary preprocessing cor norm-conformity.

Currently sphinx only computes with a wraning this is due to a change in docs/conf.py l. 106.

@SimonBuechner SimonBuechner added this to the v1.0.0 milestone Mar 13, 2026
@SimonBuechner SimonBuechner added the documentation Improvements or additions to documentation label Mar 13, 2026
@SimonBuechner SimonBuechner moved this from Backlog to Require review in Weekly Planning Mar 13, 2026
@SimonBuechner
Copy link
Contributor Author

Additionally to the proposed changes, this could also be used to implement all neccessary minor changes from a final documentation review.

Copy link
Member

@mberz mberz left a comment

Choose a reason for hiding this comment

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

Thanks, I only have small comments.
Please revert the unrelated changes before we can merge this.

@SimonBuechner
Copy link
Contributor Author

Thanks, I only have small comments. Please revert the unrelated changes before we can merge this.

Which unrelated changes do you mean?

@f-brinkmann f-brinkmann self-requested a review March 19, 2026 07:31
@mberz
Copy link
Member

mberz commented Mar 19, 2026

Thanks, I only have small comments. Please revert the unrelated changes before we can merge this.

Which unrelated changes do you mean?

You already removed them, thanks! :)

@mberz mberz force-pushed the docs/v1_refactoring branch from fe8eadb to f803feb Compare March 19, 2026 15:27
@mberz mberz self-requested a review March 19, 2026 15:34
@github-project-automation github-project-automation bot moved this from Require review to Reviewer Approved in Weekly Planning Mar 19, 2026
@mberz mberz merged commit 860b106 into develop Mar 19, 2026
11 checks passed
@github-project-automation github-project-automation bot moved this from Reviewer Approved to Done in Weekly Planning Mar 19, 2026
@mberz mberz deleted the docs/v1_refactoring branch March 19, 2026 15:35
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

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants